Skip to content

Create a rider line

Advancing module

POST/rider-linesriderLines.create

A rider line, reconciled against capabilities. Creates a rider line. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability advancing.rider.write.
  • OAuth scopes: advancing.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: RiderLineCreate

riderLines.create: RiderLineCreate
FieldTypeRequiredDescription
rider_idstring (uuid)YesIdentifier of the rider.
quantitynumber | nullNoQuantity.
descriptionstringYesWhat is asked.Constraints: length 1 to 500
element_idstring | nullNoCatalog element that fulfills the ask.Constraints: length 1 to 64
fulfilled_atstring (date-time) | nullNoWhen the ask was fulfilled; NULL while open.
{
  "rider_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "quantity": 2,
  "description": "Two wedge monitors per vocalist.",
  "element_id": "5000.02.01-NWL-001",
  "fulfilled_at": "2026-10-08T14:30:00Z"
}

Response 201: RiderLine

riderLines.create: RiderLine
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the rider line.
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.
rider_idstring (uuid)YesIdentifier of the rider.
quantitynumber | nullYesQuantity.
descriptionstringYesWhat is asked.Constraints: length 1 to 500
element_idstring | nullYesCatalog element that fulfills the ask.Constraints: length 1 to 64
fulfilled_atstring (date-time) | nullYesWhen the ask was fulfilled; NULL while open.
{
  "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",
  "rider_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "quantity": 2,
  "description": "Two wedge monitors per vocalist.",
  "element_id": "5000.02.01-NWL-001",
  "fulfilled_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X POST "$XOS_BASE_URL/rider-lines" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"rider_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","quantity":2,"description":"Two wedge monitors per vocalist.","element_id":"5000.02.01-NWL-001","fulfilled_at":"2026-10-08T14:30:00Z"}'
const { data } = await xos.riderLines.create({
    "rider_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "quantity": 2,
    "description": "Two wedge monitors per vocalist.",
    "element_id": "5000.02.01-NWL-001",
    "fulfilled_at": "2026-10-08T14:30:00Z"
  });
response = xos.rider_lines.create({"rider_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "quantity": 2, "description": "Two wedge monitors per vocalist.", "element_id": "5000.02.01-NWL-001", "fulfilled_at": "2026-10-08T14:30:00Z"})
xos rider-lines create --data '{"rider_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","quantity":2,"description":"Two wedge monitors per vocalist.","element_id":"5000.02.01-NWL-001","fulfilled_at":"2026-10-08T14:30:00Z"}'