Skip to main content
PATCH
Update a ticket

Authorizations

Authorization
string
header
required

OAuth Bearer access tokens or Flow API keys with the required Flow scope families for the route.

Headers

Idempotency-Key
string

Optional idempotency key for retry-safe write operations. For implemented representative writes, the same key plus the same request fingerprint replays the accepted result with meta.replayed=true in the response body. Stored HTTP responses for create requests in the customer API retain their original success status, including 201 Created and 202 Accepted. An in-progress key returns 409 idempotency_key_in_progress. A reused key with a different request fingerprint returns 409 idempotency_key_reused. Replay state is not signaled through an X-Idempotent-Replayed header.

Maximum string length: 255

Path Parameters

key
string
required

Org-scoped human ticket key (for example PLAT-1). Internal ticket UUIDs are not valid path values.

Body

application/json
data
object
required

Partial update payload; must include at least one mutable field.

Response

Ticket detail response with messages, activities, and linked domain observations.

data
object
required

Key-addressed ticket detail returned by runtime mutation and slash-command routes. It retains the runtime workflow observation status vocabulary rather than the customer read-model enum.

meta
object
required