Send an advance packet
Advancing module
POST/advance-packets/{id}/sendadvancePackets.send
Sends the packet to every recipient. Recipients without an account receive a token link and access code. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability advancing.packet.send.
- OAuth scopes: advancing.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the advance packet. |
Response 200: AdvancePacket
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the advance packet. |
| 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. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| title | string | Yes | Packet title.Constraints: length 1 to 300 |
| due_at | string (date-time) | null | Yes | When submissions are due. |
| sent_at | string (date-time) | null | Yes | 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"
}Code samples
curl -X POST "$XOS_BASE_URL/advance-packets/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/send" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.advancePackets.send("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.advance_packets.send("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos advance-packets send 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f