Create a new Omnichannel custom field or update an existing on. You can refer to the Omnichannel Custom Fields user guide for details.
Permission required: view-livechat-manager
Changelog
| Version | Description |
|---|---|
| 7.11.0 | Added |
The authToken of the authenticated user.
The userId of the authenticated user.
{
"customFieldData": {
"field": "new1",
"label": "new11",
"visibility": true,
"scope": "visitor",
"type": "select",
"searchable": true,
"regexp": "",
"required": false,
"defaultValue": "",
"options": "optionA, optionB",
"public": true
}
}If you want to update an existing custom field, enter the field value.
In this object, provide the custom field data.
Enter a value for the field.
Enter a label for the field.
Enter whether the custom field is displayed in a contact’s details.
Set the scope of the custom field. The options are: visitor and room.
Refer to the user guide for details.
Set the input type of this field. The options are: input and select.
Set whether or not searching in the Omnichannel Contact Center can be done with the custom field.
Validate the values entered for the custom field using regular expressions. For example, [a-z]. This means that the custom field only accepts lowercase letters. Any other characters will display an error message.
Set whether or not this field should be mandatory.
Enter a default value for the field.
If the field type is select, enter the options that users can select. The values must be comma-separated.
If enabled, the custom field will be displayed in external applications, such as Livechat.
OK
{
"customField": {
"label": "address11",
"scope": "visitor",
"visibility": true,
"type": "input",
"searchable": true,
"regexp": "",
"required": false,
"defaultValue": "",
"options": "",
"public": true,
"_updatedAt": "2025-10-06T06:52:40.102Z"
},
"success": true
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}Forbidden
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}