Update a customer

Update one or more fields on a customer.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

customers:write

Path Parameters

Name	Type	Required	Description
`accountId`	string	Required	Customer (account) ID.

Request Body

Property	Type	Required	Description
`fullname`	string	Optional	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.

PATCHExample request

curl

curl -X PATCH "https://www.pxb.app/api/public/v1/customers/{accountId}" \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "ACTIVE"
  }'

200Example response

json

{
  "message": "Customer updated 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

Open a customer and edit their details.