Update an event (status / assignee / comment)
PATCH/v2/events/:id
Partial update of a single event addressed by its event_record_identifier.
- status: client-facing status label.
- assignee_email: email of the new assignee, or
nullto unassign. Same semantics as the dedicated/assigneeroute. - comment: free-text comment attached to the event.
Scope note: events do not carry a priority in the platform, so there is no priority field on this route (incident priority is a separate concept on the incident routes). Event severity is expressed as magnitude on the read APIs; updating magnitude through this API is deferred to a future release.
Rescan behaviour: when rescan is enabled for the event's module, a write against a stale
event id is transparently redirected to the latest event in the same series; the response
carries rescan_redirect_applied: true plus the originally requested identifier.
Invalid identifiers: an identifier that is not a valid event_record_identifier is
rejected with 400 VALIDATION_ERROR; a well-formed identifier that matches no event in
the token's org tree returns 404 EVENT_NOT_FOUND.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 503
Update applied.
Validation failure. See error.code (VALIDATION_ERROR, INVALID_STATUS_TRANSITION, COMMENT_REQUIRED, USER_NOT_FOUND, INVALID_DISPLAY_ID, BULK_ACTION_FIELD_MISMATCH, BULK_LIMIT_EXCEEDED).
UNAUTHORIZED: missing or invalid bearer token, or wrong token type for a write route.
Access denied. Possible codes are ACCESS_DENIED, TWO_WAY_DISABLED, MODULE_ACCESS_DENIED, INCIDENT_ARCHIVED, org/user inactive, or integration configuration inactive.
Target entity (or job) not found in the token's org tree.
RATE_LIMIT_EXCEEDED: the per-token budget is exhausted. Back off per the Retry-After header.
Response Headers
Seconds to wait before retrying.
INTEGRATION_PLATFORM_UNAVAILABLE or INTEGRATION_AUTH_UNAVAILABLE: transient upstream failure, safe to retry.