Create a customer

Create a new customer (account) within a location.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

customers:write

Request Body

Property	Type	Required	Description
`locationId`	string	Required	Location that owns the customer.
`fullname`	string	Required	Customer full name.
`email`	string	Optional	Email address.
`phoneNumber`	string	Optional	Phone number.
`birthday`	string	Optional	ISO date of birth.
`notes`	string	Optional	Free-form notes.
`status`	string	Optional	Account status.

POSTExample request

curl

curl -X POST "https://www.pxb.app/api/public/v1/customers" \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "locationId": "loc_abc",
    "fullname": "John Doe",
    "email": "john@example.com"
  }'

200Example response

json

{
  "message": "Customer created successfully!",
  "content": {
    "customer": {
      "id": "cust_1"
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

xRM → Accounts

/xrm

Add an account.