Skip to main content
POST
Delete member

Restrictions

Usage

  • Identify the member with one of the lookup fields; when several are sent, the first non-empty one wins in the order member_id, member_name, email, phone, ref_id.
  • Unless is_force is true, the call fails with 400 ReferenceExist while the member belongs to a team, is a direct target of an escalation rule, or is in a schedule; data.refs lists each reference. A forced delete skips this check and leaves those references in place.
  • Deletion is soft: the member’s status becomes deleted, any license seat the member holds is released, and the member’s SSO identity links are removed. The member still resolves through POST /person/infos.
  • Members provisioned through SSO cannot be deleted while the SSO configuration marks them non-editable or the account has no active SSO configuration; the call returns 400.
  • 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

Delete member request (provide one of the lookup fields)

member_id
integer<uint64>
required

Member ID. When several lookup fields are provided, the first non-empty one wins in the order member_id > member_name > email > phone > ref_id

member_name
string

Member name. Only used when member_id is not provided

email
string

Email address. Only used when neither member_id nor member_name is provided

phone
string

Phone number. Only used when member_id, member_name, and email are all absent

country_code
string

Region hint for parsing phone when it has no "+" prefix — an ISO 3166-1 alpha-2 code such as "CN" (the default when omitted). Legacy digit calling codes like "86" are still accepted in this parsing context.

ref_id
string

External reference ID. Only used when all other lookup fields are absent

is_force
boolean
default:false

Skip the reference check. When false (default), the call fails with ReferenceExist if the member belongs to a team, is targeted by an escalation rule, or is in a schedule. A forced delete does not remove those references.

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

Empty response