Skip to main content
POST
/
customers
Create a customer
curl --request POST \
  --url https://base_url/api/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Doe",
  "corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
  "email": "[email protected]",
  "shipping_address": {
    "postal_code": "90401",
    "state": "CA",
    "country": "US",
    "address_line_1": "1776 Main St",
    "address_line_2": "Apt. #123",
    "address_line_3": "<string>",
    "city": "Santa Monica"
  },
  "external_id": "<string>"
}
'
{
  "data": {
    "id": "b6d009b0-d174-463f-b030-94643c28e209",
    "corporation_id": "2535af08-a139-4d0c-9827-1651e46dfbcf",
    "name": "John Doe",
    "email": "[email protected]",
    "shipping_address": {
      "postal_code": "90401",
      "state": "CA",
      "country": "US",
      "address_line_1": "1776 Main St",
      "address_line_2": "Apt. #123",
      "address_line_3": "<string>",
      "city": "Santa Monica"
    },
    "external_id": "<string>"
  },
  "message": "Successfully created customer."
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

A display name for this customer.

Minimum string length: 3
Example:

"John Doe"

​
corporation_id
string
required

The unique identifier for a corporation this customer belongs to.

Example:

"b6d009b0-d174-463f-b030-94643c28e209"

​
email
string<email>

Email address of the customer.

​
shipping_address
object
​
external_id
string

External identifier for the customer.

Response

Information about the created customer

​
data
object
​
message
string
Example:

"Successfully created customer."