Skip to main content
POST
Archive a recipient
Archiving cancels the recipient’s pending information request.
Any scheduled payments that still target the recipient’s destinations are canceled. Canceled scheduled payments are not restored if the recipient is later unarchived.

Authorizations

X-API-Key
string
header
required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Path Parameters

recipientId
string
required

Recipient id.

Response

The archived recipient.

A person or business you pay, and the owner of the destinations you pay them at.

id
string
required

Recipient id.

name
string
required

Display name visible to your organization.

recipientType
enum<string>
required

contact is a person (shown as "Person" in the Slash dashboard); vendor is a business.

Available options:
contact,
vendor
status
enum<string>
required
Available options:
active,
archived
createdAt
string<date-time>
required
recipientEmail
string
address
Address · object
archivedAt
string<date-time>