Skip to content

Update a rider

Advancing module

PATCH/riders/{id}riders.update

A technical or hospitality rider for an engagement. 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 advancing.rider.write.
  • OAuth scopes: advancing.
  • 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

riders.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the rider.

Request body: RiderUpdate

riders.update: RiderUpdate
FieldTypeRequiredDescription
titlestringNoRider title.Constraints: length 1 to 300
counterparty_idstring (uuid) | nullNoIdentifier of the counterparty whose rider it is.
{
  "title": "Technical Rider 2026",
  "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Response 200: Rider

riders.update: Rider
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the rider.
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.
titlestringYesRider title.Constraints: length 1 to 300
project_idstring (uuid)YesIdentifier of the project.
counterparty_idstring (uuid) | nullYesIdentifier of the counterparty whose rider it is.
{
  "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",
  "title": "Technical Rider 2026",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/riders/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 '{"title":"Technical Rider 2026","counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data, etag } = await xos.riders.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "title": "Technical Rider 2026",
    "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  }, { ifMatch: etag });
response = xos.riders.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"title": "Technical Rider 2026", "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}, if_match=etag)
xos riders update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"title":"Technical Rider 2026","counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}' --if-match auto