Skip to main content
POST
Create a recipient

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

X-Idempotency-Key
string
required

Unique caller-generated key for one create request. Once an authenticated, schema-valid request reaches the operation, the key is permanently consumed for that operation and legal entity whether the operation succeeds or fails. Reusing it in that scope returns 409 and never replays a response, unlike API v1, which replays the original response for a matching key.

Required string length: 1 - 255

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]+$

Body

application/json

The person or business you will pay.

name
string
required

Display name visible to your organization.

Required string length: 1 - 255
recipientType
enum<string>
required

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

Available options:
contact,
vendor
Required string length: 1 - 255
recipientEmail
string<email>
address
Address · object

Response

The created 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>