Skip to main content
POST
Update incident custom field

Restrictions

Usage

  • The field must exist and be enabled on the account; field_value must match its type and options.
  • Omitting field_value or sending null clears the field on the incident.
  • If the value equals the current one, nothing changes.
  • A change adds a field-change entry to the incident timeline and triggers the same notifications and webhooks as a console edit.

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 updating a custom field value on an incident.

incident_id
string
required

Incident ID (MongoDB ObjectID).

Pattern: ^[0-9a-fA-F]{24}$
field_name
string
required

Custom field name (the field's field_name, not its display name). The field must exist and be enabled; list fields with POST /field/list.

field_value
any

New value. Its type must match the field: checkbox takes a boolean, single_select one of the options, multi_select an array of options, text a string. Omit it or send null to clear the field.

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.