Skip to main content
POST
Delete member

Restrictions

Usage

  • By default (is_force=false), the system checks whether the member is referenced by other resources (e.g., escalation rules, schedules). If references exist, the API returns error code ReferenceExist with the reference list in data.refs. Set is_force=true to skip the reference check and force delete.
  • Members provisioned via SSO with sso_user_non_editable=true cannot be deleted through this API. Disable that SSO restriction first.
  • This operation is recorded in the audit log.

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

Delete member request (provide one of the lookup fields)

member_id
integer<uint64>

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

Force delete. Defaults to false, which checks for references from escalation rules, schedules, etc. Set to true to skip the reference check and delete immediately

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

Empty response