Skip to content
XOS Developers

advanceRecipients

Advancing module · 4 operations

List advance recipient rows

GET/advance-recipients

A party bound to an advance packet. Recipients without an account use a token and access code. Returns a cursor page of advance recipient rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create an advance recipient

POST/advance-recipients

A party bound to an advance packet. Recipients without an account use a token and access code. Creates an advance recipient. 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 recipient

GET/advance-recipients/{id}

A party bound to an advance packet. Recipients without an account use a token and access code. Returns one advance recipient with its `ETag`. A advance recipient the caller may not see returns 404.

Delete an advance recipient

DELETE/advance-recipients/{id}

A party bound to an advance packet. Recipients without an account use a token and access code. Soft-deletes the advance recipient: it moves to Trash and can be restored for its table's retention period.