Skip to main content
POST
Update incident fields

Restrictions

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 updating user-editable fields of an incident. At least one field must be provided; the handler will update only the fields you supply.

incident_id
string
required

Incident ID (MongoDB ObjectID).

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

New incident title.

Required string length: 3 - 200
description
string

New description.

Required string length: 3 - 6144
impact
string

New impact description.

Required string length: 3 - 6144
root_cause
string

New root cause analysis.

Required string length: 3 - 6144
resolution
string

New resolution notes.

Required string length: 3 - 6144
incident_severity
enum<string>

New severity.

Available options:
Info,
Warning,
Critical

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.