Skip to main content
POST
Add incident responder

Restrictions

Usage

  • Existing responders are kept, and IDs that are already responders are skipped. To replace the responder set, use POST /incident/assign.
  • Closed incidents are rejected with InvalidParameter.
  • Member IDs that do not exist in the account are ignored.
  • New responders are notified according to notify; by default each follows their personal notification preference.

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

Parameters for adding responders to an existing incident. At least one of person_ids and team_ids is required.

incident_id
string
required

Incident ID (MongoDB ObjectID).

Pattern: ^[0-9a-fA-F]{24}$
person_ids
integer<int64>[]

Member IDs to add as responders (at most 100). IDs that are already responders, or that do not exist in the account, are skipped.

Maximum array length: 100
team_ids
integer<int64>[]

Team IDs whose members are added as responders (at most 20). Each team is expanded to its enabled members, merged with person_ids, and the result is capped at 100 responders.

Maximum array length: 20
notify
object

Notification settings for the newly added responders. Defaults to {"follow_preference": true}.

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

No payload. Depending on the operation, data is {} or omitted from the envelope; rely only on the HTTP 200 status and the absence of error.