Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

customer
string
required

Body

application/json

A person at a customer.

name
string
required
Maximum string length: 255
role
string | null

Their job, such as Sales or Accounts.

Maximum string length: 100
email
string<email> | null
Maximum string length: 255
phone
string | null
Maximum string length: 50

Response

SalesCustomerResource

data
SalesCustomerResource · object
required