PUT
/api/public/v1/customers/{accountId}/custom-fields

Set customer custom field values

Bulk upsert custom field values for 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.

customer:custom-fields:write

Path Parameters

NameTypeRequiredDescription
accountIdstringRequiredCustomer (account) ID.

Request Body

PropertyTypeDescription
valuesarrayArray of { customFieldId, value }. value is coerced based on the field type.
PUTExample request
curl
curl -X PUT "https://www.pxb.app/api/public/v1/customers/{accountId}/custom-fields" \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "values": [
      {
        "customFieldId": "cf_1",
        "value": "email"
      }
    ]
  }'
200Example response
json
{
  "message": "Customer custom field values saved successfully!",
  "content": {}
}

In the console

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

xRM → Accounts
/xrm
  1. Open a customer and edit their custom field values.