Skip to main content
POST
Convert a work item to a follow-up

Restrictions

Usage

  • Requires the On-call Pro license.
  • Converts an action into a post-mortem follow_up in place — the work_item_id does not change.
  • Converting an item that is already a follow_up changes nothing and returns idempotent_replay: true.
  • If the incident already has a post-mortem, the item is bound to it, which requires edit access to that report; otherwise bind it later with POST /incident/work-item/post-mortem/bind.
  • The caller needs edit access to the item’s anchor: the post-mortem when the item is bound to one, otherwise the incident.
  • Optimistic locking — version must equal the item’s current version; a mismatch returns RequestLocked (HTTP 423). Re-read the item and retry.
  • Every call is recorded in the account audit log. Don’t put secrets in request fields.

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 converting an action item into a post-mortem follow-up in place.

work_item_id
string
required

Work item ID (opaque string, max 128 characters).

Maximum string length: 128
version
integer<int64>
required

The item's current version (≥ 1) for optimistic locking.

idempotency_key
string
required

Client-generated idempotency key (max 128 characters; letters, digits, _, -, ., : only).

Maximum string length: 128
Pattern: ^[A-Za-z0-9_\-.:]+$
target_status
enum<string> | null

Optional status to set on the converted follow-up; omitted or null keeps the current status. Values: open (not started), in_progress (being worked on), done (finished), cancelled (no longer needed).

Available options:
open,
in_progress,
done,
cancelled,
null
Maximum string length: 64

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

Result of mutating a work item. item is absent for delete.