Review an advance answer

Módulo Advancing

POST/advance-submissions/{id}/reviewadvanceSubmissions.review

Records the one review of an answer: Accepted, or Returned with a reason the recipient reads. The database stamps the reviewer and time and refuses the person who submitted it (sod_advance_submitter) or a second review (422). Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

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, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

advanceSubmissions.review: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the advance submission.

Cuerpo de la solicitud: AdvanceSubmissionReviewRequest

advanceSubmissions.review: AdvanceSubmissionReviewRequest
Campo	Tipo	Obligatorio	Descripción
outcome	"Accepted" \| "Returned"	Sí	Accepted, or Returned to the recipient to answer again.
return_reason	string	No	Why the answer is returned; required when Returned, shown to the recipient.Restricciones: length 1 to 1000

{
  "outcome": "Returned",
  "return_reason": "Please add the flight number."
}

Respuesta 200: AdvanceSubmission

advanceSubmissions.review: AdvanceSubmission
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the advance submission.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
advance_section_id	string (uuid)	Sí	Identifier of the advance section.
advance_recipient_id	string (uuid)	Sí	Identifier of the advance recipient.
submitted_at	string (date-time)	Sí	When it was submitted.
body	string	Sí	The answer as rich text.Restricciones: length 1 to 20000
reviewed_at	string (date-time) \| null	Sí	When the answer was reviewed.
reviewed_by	string (uuid) \| null	Sí	Identifier of the person who reviewed the answer.
review_outcome	"Accepted" \| "Returned" \| null	Sí	Accepted or Returned.
return_reason	string \| null	Sí	Why the answer was returned.Restricciones: length 1 to 1000
via_link	boolean	Sí	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/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/review" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"outcome":"Returned","return_reason":"Please add the flight number."}'

const { data } = await xos.advanceSubmissions.review("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "outcome": "Returned",
    "return_reason": "Please add the flight number."
  });

response = xos.advance_submissions.review("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"outcome": "Returned", "return_reason": "Please add the flight number."})

xos advance-submissions review 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"outcome":"Returned","return_reason":"Please add the flight number."}'