Skip to content

Update a dispatch assignment

Safety module

PATCH/dispatch-assignments/{id}dispatchAssignments.update

A responder dispatched to 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.dispatch.
  • 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

dispatchAssignments.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the dispatch assignment.

Request body: DispatchAssignmentUpdate

dispatchAssignments.update: DispatchAssignmentUpdate
FieldTypeRequiredDescription
arrived_atstring (date-time) | nullNoWhen the responder arrived.
{
  "arrived_at": "2026-10-08T14:30:00Z"
}

Response 200: DispatchAssignment

dispatchAssignments.update: DispatchAssignment
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the dispatch assignment.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
incident_idstring (uuid)YesIdentifier of the incident.
dispatched_atstring (date-time)YesWhen the responder was dispatched.
arrived_atstring (date-time) | nullYesWhen the responder arrived.
membership_idstring (uuid)YesIdentifier of the responder's membership.
{
  "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",
  "dispatched_at": "2026-10-08T14:30:00Z",
  "arrived_at": "2026-10-08T14:30:00Z",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/dispatch-assignments/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 '{"arrived_at":"2026-10-08T14:30:00Z"}'
const { data, etag } = await xos.dispatchAssignments.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "arrived_at": "2026-10-08T14:30:00Z"
  }, { ifMatch: etag });
response = xos.dispatch_assignments.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"arrived_at": "2026-10-08T14:30:00Z"}, if_match=etag)
xos dispatch-assignments update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"arrived_at":"2026-10-08T14:30:00Z"}' --if-match auto