Skip to main content
POST
Complete a work item

Restrictions

Usage

  • Requires the On-call Pro license.
  • target_status must be done.
  • Only a current person assignee can complete the item (account owners and admins are not implicit assignees); an item assigned to AI SRE can also be completed by the AI SRE session working on it. The caller also needs read access to the incident or post-mortem.
  • A follow_up item can be changed only while its incident is closed.
  • Repeating the call with the same idempotency_key returns the item with idempotent_replay: true.
  • 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 completing a work item.

work_item_id
string
required

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

Maximum string length: 128
version
integer<int64>
required

Current item version for optimistic locking. Must match the stored version.

target_status
enum<string>
required

Target status. Must be done; any other value is rejected.

Available options:
done
Maximum string length: 64
idempotency_key
string
required

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

Maximum string length: 128
Pattern: ^[A-Za-z0-9_\-.:]+$

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.