This API updates user information in the Customer Info pane.
The request body parameters either add new information or override existing details. Field names must match the Unique Name column in the Custom Fields module (case-sensitive).
Custom fields added in the Custom Fields module are included in the Content field (capital "C") of the API request. (See example.)
Once successful, this API returns the User ID.
API key is needed to authorize requests. You can get your API key via the management console.
A Bearer Token is needed to be set in the Authorization header of every API call.
For additional support you can contact us.
User ID. This is a commbox generated number
Optional description for new mail object in Markdown
{
"data": {
"UniqueId": "0123456789",
"FirstName": "John",
"LastName": "Doe",
"Phone1": "19175555555",
"Email": "JohnDoe@gmail.com",
"Remarks": "Some remarks about the customer",
"Content": {
"Birth_Date": "1983-01-01",
"VIP_Status": "8"
}
}
}User’s unique identifier. This can be an email, social security number or any other type of unique string determined by the brand administrators
User’s first name
User’s last name
User's Email.
User’s main phone number
User’s secondary phone number
Free text containing general remarks about the user
This is an example of Custom Field
This is an example of Custom Field
OK
Bad Request - The request could not be understood by the server. Incoming parameters might not be valid
Unauthorized - The supplied credentials, if any, are not sufficient to access the resource
Not Found - The requested resource is not found
Too Many Requests - Too many requests have been made in a short period of time (Throttling)
Internal Server Error - The server could not return the representation due to an internal server error
{
"status": 500,
"description": "Operation failed",
"response_time": "2025-04-15T07:24:52.956Z"
}Not Implemented - The requested operation is not supported