Skip to content

Update a BEO

Hospitality module

PATCH/beos/{id}beos.update

A banquet event order. 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 hospitality.beo.write.
  • OAuth scopes: hospitality.
  • 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

beos.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the beo.

Request body: BeoUpdate

beos.update: BeoUpdate
FieldTypeRequiredDescription
fulfillment_idstring (uuid) | nullNoIdentifier of the catering fulfillment.
event_atstring (date-time)NoService time.
guest_countinteger | nullNoGuaranteed count.Constraints: range 0 to any
{
  "fulfillment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "event_at": "2026-10-08T14:30:00Z",
  "guest_count": 140
}

Response 200: Beo

beos.update: Beo
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the beo.
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.
project_idstring (uuid)YesIdentifier of the project.
fulfillment_idstring (uuid) | nullYesIdentifier of the catering fulfillment.
event_atstring (date-time)YesService time.
guest_countinteger | nullYesGuaranteed count.Constraints: range 0 to any
beo_numberintegerYesNumber within the project; the display key is {project_key}-{beo_number}.Constraints: range 1 to any
approved_atstring (date-time) | nullYesWhen the BEO was approved.
approved_bystring (uuid) | nullYesIdentifier of the person who approved the BEO; never its author.
{
  "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",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "fulfillment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "event_at": "2026-10-08T14:30:00Z",
  "guest_count": 140,
  "beo_number": 4,
  "approved_at": "2026-10-08T14:30:00Z",
  "approved_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

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