Skip to main content
DELETE
/
v0
/
external-recipients
/
{id}
Archive external recipient
curl --request DELETE \
  --url https://api.getlemma.com/v0/external-recipients/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "external_account_Bx5nTm8hKw3pVd7c",
  "status": "archived",
}

Documentation Index

Fetch the complete documentation index at: https://docs.getlemma.com/llms.txt

Use this file to discover all available pages before exploring further.

Archives an external recipient. Lemma never deletes external recipients. This endpoint sets the recipient’s status to archived instead. Archived recipients remain in your account for reconciliation and audit purposes, but Lemma will reject any new transfers to them. Archived recipients are excluded from the List external recipients endpoint but can still be retrieved directly with Get external recipient. They also remain visible in your transaction history.

​
Path parameters

​
id
string
required
The ID of the external recipient to archive.

​
Response

Returns the archived external recipient object.
​
id
string
Unique identifier for the external recipient.
​
status
string
Always archived after this call.
{
  "id": "external_account_Bx5nTm8hKw3pVd7c",
  "status": "archived",
}