Skip to main content
POST
Invite members

Restrictions

Usage

  • Each entry needs email, or member_name together with phone.
  • Entries whose email or phone already belongs to a member of the account are skipped silently; items lists only the members created by this call and is null when none were created.
  • New members are created in pending status and are sent an invitation by email or SMS.
  • Emails are stored in lower case. If the account restricts member email domains, an address outside the allowlist returns 400; duplicate emails or phones within one request also return 400.
  • 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).
  • Every call is recorded in the account audit log. Don’t put secrets in request fields.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Invite members request

members
object[]
required

Members to invite in one call (at least 1). Each entry needs either an email, or member_name + phone together. At most 20 items per request; split larger sets into several calls.

Required array length: 1 - 20 elements
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

Invite members response