Skip to main content
POST
Invite members

Restrictions

Usage

  • country_code must be an ISO 3166-1 alpha-2 region code (e.g. “CN”). It is validated and normalized to upper case before storage; invalid values are rejected with a 400.
  • When a member’s phone has no ”+” prefix, it is parsed with that member’s country_code as the region hint (defaults to “CN” when omitted).

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

Invite members request

members
object[]
required

Members to invite (max 20)

from
string

Invite source. Only takes effect when the account has member invites disabled and the value is api: members are created directly in the enabled state with email/phone marked verified and no invitation sent. Any other value follows the normal invite flow

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
required

Invite members response