Create an advance packet

Módulo Advancing

POST/advance-packetsadvancePackets.create

An advance packet sent to parties for one project. Creates an advance packet. 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: AdvancePacketCreate

advancePackets.create: AdvancePacketCreate
Campo	Tipo	Obligatorio	Descripción
project_id	string (uuid)	Sí	Identifier of the project.
title	string	Sí	Packet title.Restricciones: length 1 to 300
due_at	string (date-time) \| null	No	When submissions are due.

{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "title": "Headliner Advance",
  "due_at": "2026-10-08T14:30:00Z"
}

Respuesta 201: AdvancePacket

advancePackets.create: AdvancePacket
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the advance packet.
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.
project_id	string (uuid)	Sí	Identifier of the project.
title	string	Sí	Packet title.Restricciones: length 1 to 300
due_at	string (date-time) \| null	Sí	When submissions are due.
sent_at	string (date-time) \| null	Sí	When the packet was sent.

{
  "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",
  "title": "Headliner Advance",
  "due_at": "2026-10-08T14:30:00Z",
  "sent_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/advance-packets" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","title":"Headliner Advance","due_at":"2026-10-08T14:30:00Z"}'

const { data } = await xos.advancePackets.create({
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "title": "Headliner Advance",
    "due_at": "2026-10-08T14:30:00Z"
  });

response = xos.advance_packets.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "title": "Headliner Advance", "due_at": "2026-10-08T14:30:00Z"})

xos advance-packets create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","title":"Headliner Advance","due_at":"2026-10-08T14:30:00Z"}'