Skip to main content
POST
Update a work item

Restrictions

Usage

  • Requires the On-call Pro license.
  • Partial patch: omitted fields and fields sent as null stay unchanged. Send "" to clear description or priority; title and status cannot be empty.
  • Optimistic locking — version must equal the item’s current version; a mismatch returns RequestLocked (HTTP 423). Re-read the item and retry.
  • When nothing would change, the current item is returned without checking version and without incrementing it.
  • The caller needs edit access to the item’s anchor: the post-mortem when the item is bound to one, otherwise the incident.
  • A follow_up item can be changed only while its incident is closed.
  • Assignees, item_type, and the incident/post-mortem anchors cannot be changed here — use the dedicated endpoints.
  • 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

Partial patch for a work item. Omitted fields and fields sent as null stay unchanged.

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.

title
string | null

New title, at most 512 characters; trimmed and must not be blank. null or omitted keeps the current title.

Maximum string length: 512
description
string | null

New description, at most 65,535 characters; "" clears it. null or omitted keeps the current value.

Maximum string length: 65535
status
enum<string> | null

New status. null or omitted keeps the current status.

  • open: not started.
  • in_progress: being worked on.
  • done: finished.
  • cancelled: no longer needed.
Available options:
open,
in_progress,
done,
cancelled,
null
priority
string | null

New free-form priority, at most 64 characters; "" clears it. null or omitted keeps the current value.

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.