Update an advance section

Advancing module

PATCH/advance-sections/{id}advanceSections.update

A section of an advance packet. 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.packet.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

advanceSections.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the advance section.

Request body: AdvanceSectionUpdate

advanceSections.update: AdvanceSectionUpdate
Field	Type	Required	Description
position	integer	No	Section order.Constraints: range 1 to any
title	string	No	Section title.Constraints: length 1 to 300
prompt	string \| null	No	What the recipient is asked.Constraints: length 1 to 2000

{
  "position": 1,
  "title": "Hospitality",
  "prompt": "When does the party arrive?"
}

Response 200: AdvanceSection

advanceSections.update: AdvanceSection
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the advance section.
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.
advance_packet_id	string (uuid)	Yes	Identifier of the advance packet.
position	integer	Yes	Section order.Constraints: range 1 to any
title	string	Yes	Section title.Constraints: length 1 to 300
prompt	string \| null	Yes	What the recipient is asked.Constraints: length 1 to 2000

{
  "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",
  "advance_packet_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "position": 1,
  "title": "Hospitality",
  "prompt": "When does the party arrive?"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/advance-sections/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 '{"position":1,"title":"Hospitality","prompt":"When does the party arrive?"}'

const { data, etag } = await xos.advanceSections.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "position": 1,
    "title": "Hospitality",
    "prompt": "When does the party arrive?"
  }, { ifMatch: etag });

response = xos.advance_sections.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"position": 1, "title": "Hospitality", "prompt": "When does the party arrive?"}, if_match=etag)

xos advance-sections update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"position":1,"title":"Hospitality","prompt":"When does the party arrive?"}' --if-match auto