POST
/
customers
curl --request POST \
  --url https://connect.withvayu.com/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "aliases": [],
  "address": {
    "country": "<string>",
    "city": "<string>",
    "addressText": "<string>",
    "state": "<string>",
    "postalCode": "<string>"
  },
  "contacts": [
    {
      "name": "<string>",
      "email": "jsmith@example.com",
      "receiveInvoiceEmail": true
    }
  ],
  "externalId": "<string>"
}'
{
  "customer": {
    "name": "<string>",
    "aliases": [],
    "address": {
      "country": "<string>",
      "city": "<string>",
      "addressText": "<string>",
      "state": "<string>",
      "postalCode": "<string>"
    },
    "contacts": [
      {
        "name": "<string>",
        "email": "jsmith@example.com",
        "receiveInvoiceEmail": true
      }
    ],
    "externalId": "<string>",
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

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

The name of the customer

Minimum length: 1
​
aliases
string[] | null

The aliases of the customer used to match events to the customer.

​
address
object

The address of the customer

​
contacts
object[]

The contacts of the customer. Contact marked as primary is the target for invoice sharing.

​
externalId
string

The external ID of the customer

Minimum length: 1

Response

200
application/json
RequestSuccess
​
customer
object
required