Skip to main content
POST
Complete a work item

Restrictions

Usage

  • Requires the On-call Pro license.
  • Only current assignees can complete a work item.
  • target_status is a client-defined string — there is no fixed state machine.
  • The same idempotency_key with the same target_status replays idempotently; the same key with a different target_status returns an error.
  • 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 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
string
required

Client-defined status to set (max 64 characters). There is no fixed state machine.

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
required

Result of mutating a work item.