Saltar al contenido

Create an advance submission

Módulo Advancing

POST/advance-submissionsadvanceSubmissions.create

A recipient's submission for one section. Creates an advance submission. 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.submission.review.
  • 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: AdvanceSubmissionCreate

advanceSubmissions.create: AdvanceSubmissionCreate
CampoTipoObligatorioDescripción
advance_section_idstring (uuid)SíIdentifier of the advance section.
advance_recipient_idstring (uuid)SíIdentifier of the advance recipient.
bodystringSíThe answer as rich text.Restricciones: length 1 to 20000
{
  "advance_section_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "advance_recipient_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "body": "Party of 8 lands at 14:20."
}

Respuesta 201: AdvanceSubmission

advanceSubmissions.create: AdvanceSubmission
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the advance submission.
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_section_idstring (uuid)SíIdentifier of the advance section.
advance_recipient_idstring (uuid)SíIdentifier of the advance recipient.
submitted_atstring (date-time)SíWhen it was submitted.
bodystringSíThe answer as rich text.Restricciones: length 1 to 20000
reviewed_atstring (date-time) | nullSíWhen the answer was reviewed.
reviewed_bystring (uuid) | nullSíIdentifier of the person who reviewed the answer.
review_outcome"Accepted" | "Returned" | nullSíAccepted or Returned.
return_reasonstring | nullSíWhy the answer was returned.Restricciones: length 1 to 1000
via_linkbooleanSíTrue when the recipient answered through a Gateway link.
{
  "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_section_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "advance_recipient_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "submitted_at": "2026-10-08T14:30:00Z",
  "body": "Party of 8 lands at 14:20.",
  "reviewed_at": "2026-10-08T14:30:00Z",
  "reviewed_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "review_outcome": "Accepted",
  "return_reason": "Please add the flight number.",
  "via_link": false
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/advance-submissions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"advance_section_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","advance_recipient_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","body":"Party of 8 lands at 14:20."}'
const { data } = await xos.advanceSubmissions.create({
    "advance_section_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "advance_recipient_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "body": "Party of 8 lands at 14:20."
  });
response = xos.advance_submissions.create({"advance_section_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "advance_recipient_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "body": "Party of 8 lands at 14:20."})
xos advance-submissions create --data '{"advance_section_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","advance_recipient_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","body":"Party of 8 lands at 14:20."}'