Saltar al contenido

Create an advance section

Módulo Advancing

POST/advance-sectionsadvanceSections.create

A section of an advance packet. Creates an advance section. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requiere la capacidad advancing.packet.write.
  • Alcances de OAuth: advancing.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: AdvanceSectionCreate

advanceSections.create: AdvanceSectionCreate
CampoTipoObligatorioDescripción
advance_packet_idstring (uuid)SíIdentifier of the advance packet.
positionintegerSíSection order.Restricciones: range 1 to any
titlestringSíSection title.Restricciones: length 1 to 300
promptstring | nullNoWhat the recipient is asked.Restricciones: length 1 to 2000
{
  "advance_packet_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "position": 1,
  "title": "Hospitality",
  "prompt": "When does the party arrive?"
}

Respuesta 201: AdvanceSection

advanceSections.create: AdvanceSection
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the advance section.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
advance_packet_idstring (uuid)SíIdentifier of the advance packet.
positionintegerSíSection order.Restricciones: range 1 to any
titlestringSíSection title.Restricciones: length 1 to 300
promptstring | nullSíWhat the recipient is asked.Restricciones: 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?"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/advance-sections" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"advance_packet_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","position":1,"title":"Hospitality","prompt":"When does the party arrive?"}'
const { data } = await xos.advanceSections.create({
    "advance_packet_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "position": 1,
    "title": "Hospitality",
    "prompt": "When does the party arrive?"
  });
response = xos.advance_sections.create({"advance_packet_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "position": 1, "title": "Hospitality", "prompt": "When does the party arrive?"})
xos advance-sections create --data '{"advance_packet_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","position":1,"title":"Hospitality","prompt":"When does the party arrive?"}'