Update an incident party
Safety module
PATCH/incident-parties/{id}incidentParties.update
A person involved in an incident. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
- Requires the capability safety.incident.write.
- OAuth scopes: safety.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the incident party. |
Request body: IncidentPartyUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| person_id | string (uuid) | null | No | Identifier of the involved person. |
| description | string | No | Role in the incident, or a description of an unknown person.Constraints: length 1 to 300 |
{
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"description": "Witness"
}Response 200: IncidentParty
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the incident party. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| incident_id | string (uuid) | Yes | Identifier of the incident. |
| person_id | string (uuid) | null | Yes | Identifier of the involved person. |
| description | string | Yes | Role in the incident, or a description of an unknown person.Constraints: length 1 to 300 |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"incident_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"description": "Witness"
}Code samples
curl -X PATCH "$XOS_BASE_URL/incident-parties/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Witness"}'const { data, etag } = await xos.incidentParties.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"description": "Witness"
}, { ifMatch: etag });response = xos.incident_parties.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "description": "Witness"}, if_match=etag)xos incident-parties update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Witness"}' --if-match auto