Skip to main content
POST
Resolve incident

Restrictions

Usage

  • When a resolution form applies, custom_fields, summary, and images must match its visible elements and required rules.
  • For a batch, form values are accepted only when every selected incident resolves to the same form; otherwise resolve incidents individually.
  • The legacy values and custom_values properties are rejected; use custom_fields.
  • Audited — changes are 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

Parameters for resolving one or more incidents.

incident_ids
string[]
required

Incident IDs to resolve. At most 100 per call.

Required array length: 1 - 100 elements
Pattern: ^[0-9a-fA-F]{24}$
root_cause
string | null

Optional root cause note applied to every resolved incident.

Maximum string length: 1024
resolution
string | null

Optional resolution note applied to every resolved incident.

Maximum string length: 1024
description
string

New incident description, up to 6,144 characters. When set, it replaces the current description before the incident closes.

Maximum string length: 6144
custom_fields
object

Custom field values for the resolution form. Allowed keys and values depend on the incident's visible form.

images
object[]

Images attached to the resolution timeline entry.

summary
string

Form summary recorded as a timeline comment. Accepted only when the resolution form contains a summary element.

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 body. The server returns data: null on success.