Skip to main content
POST
Archive a destination
Any scheduled payments that still target the destination are canceled. Canceled scheduled payments cannot be restored.

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

destinationId
string
required

Destination id with the le_contact_destination_ prefix.

Response

The archived destination.

US routing and account details usable for ACH, wire, or realtime payments.

id
string
required

Destination id.

recipientId
string
required

The recipient that owns this destination.

name
string
required

Display name visible to your organization.

status
enum<string>
required
Available options:
active,
pending,
disabled,
archived
supportedTransferTypes
enum<string>[]
required
Available options:
ach,
wire,
realtime,
international_wire
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
type
enum<string>
required
Available options:
bank_account
bankAccount
object
required
archivedAt
string<date-time>