Update User
- 09 Jun 2025
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Update User
- Updated on 09 Jun 2025
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/users/{USER_ID}
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.
Security
HTTP
Type bearer
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.
Path parameters
USER_ID
Required
User ID. This is a commbox generated number
Body parameters
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"
}
}
}object
UniqueId
string (50)
User’s unique identifier. This can be an email, social security number or any other type of unique string determined by the brand administrators
FirstName
string (100)
User’s first name
LastName
string (100)
User’s last name
Email
string (255)
User's Email.
Phone1
string (100)
User’s main phone number
Phone2
string (100)
User’s secondary phone number
Remarks
string
Free text containing general remarks about the user
Content
object
BirthDate
string
This is an example of Custom Field
VipStatus
string
This is an example of Custom Field
Responses
200
OK
object
status
string
Example200
description
string
ExampleOperation successful
response_time
string
Example2024-08-06T07:51:52.2581942Z
data
object
Id
integer
Example94382332
400
Bad Request - The request could not be understood by the server. Incoming parameters might not be valid
401
Unauthorized - The supplied credentials, if any, are not sufficient to access the resource
404
Not found - The requested resource is not found
429
Too Many Requests - Too many requests have been made in a short period of time (Throttling)
500
Server Error - The server could not return the representation due to an internal server error
501
Not Implemented - The requested operation is not supported
Was this article helpful?
