Skip to content
XOS Developers

advancePackets

Advancing module · 6 operations

List advance packet rows

GET/advance-packets

An advance packet sent to parties for one project. Returns a cursor page of advance packet rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create an advance packet

POST/advance-packets

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.

Get an advance packet

GET/advance-packets/{id}

An advance packet sent to parties for one project. Returns one advance packet with its `ETag`. A advance packet the caller may not see returns 404.

Update an advance packet

PATCH/advance-packets/{id}

An advance packet sent to parties for one project. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Delete an advance packet

DELETE/advance-packets/{id}

An advance packet sent to parties for one project. Soft-deletes the advance packet: it moves to Trash and can be restored for its table's retention period.

Send an advance packet

POST/advance-packets/{id}/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`.