Skip to content
XOS Developers

Delete an advance recipient

Advancing module

DELETE/advance-recipients/{id}advanceRecipients.delete

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.

  • Requires the capability advancing.packet.write.
  • OAuth scopes: advancing.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

advanceRecipients.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the advance recipient.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/advance-recipients/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.advanceRecipients.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.advance_recipients.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos advance-recipients delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f