Skip to main content
POST
Update a work item

Restrictions

Usage

  • Requires the On-call Pro license.
  • Partial patch: omitted fields stay unchanged; an explicit null clears the field.
  • Optimistic locking — version must match the item’s current version; a mismatch returns a conflict error.
  • Assignees, item_type, and the incident/post-mortem anchors cannot be changed here — use the dedicated endpoints.
  • 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

Partial patch for a work item. Omitted fields stay unchanged; an explicit null clears the field.

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.

title
string | null

New title (max 512 characters).

Maximum string length: 512
description
string | null

New description (max 65,535 characters).

Maximum string length: 65535
status
string | null

New client-defined status (max 64 characters).

Maximum string length: 64
priority
string | null

New client-defined priority (max 64 characters).

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
required

Result of mutating a work item.