Skip to main content
POST
/
contact
cURL
curl --request POST \
  --url https://api.slash.com/contact \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "recipientLegalName": "<string>",
  "recipientEmail": "<string>"
}
'
{
  "contact": {
    "id": "<string>",
    "name": "<string>",
    "recipientLegalName": "<string>",
    "recipientEmail": "<string>",
    "address": {},
    "data": {},
    "archivedAt": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

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

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

Authorizations

​
X-API-Key
string
header
required

API key authentication for public API requests.

Keys come in two flavors:

  • Legal-entity-scoped keys are pinned to a single legal entity. Minted via the dashboard under a specific entity; every request acts on that entity.
  • User-scoped keys are pinned to a user and span every legal entity that user has access to. Every request made with a user-scoped key (except GET /legal-entity, which lists the legal entities the user can access) must include an x-legal-entity header naming the legal entity the request is operating on. Requests without the header are rejected with 400. The authenticated user must have an active permission role on the supplied legal entity, otherwise the request is rejected with 403.

Query Parameters

​
filter:legalEntityId
string

The legal entity ID. Required if authenticating with access to multiple legal entities.

Body

application/json
​
name
string
required

Display name of the contact.

​
recipientType
enum<string>
required

The relationship type of the contact.

Available options:
contact,
vendor
​
recipientLegalName
string
required

Legal name of the recipient.

​
recipientEmail
string

Email address of the recipient.

​
address
IAddressModel · object

Response

OK

​
contact
Contact · object
required

A contact represents a counterparty (customer, vendor, etc.) associated with a legal entity.