Post
/api/v1/livechat/custom-fields.delete
Delete an Omnichannel custom field entry. Permission required: view-livechat-manager. (On the workspace UI, go to Administration > Workspace > Permissions. Search for the View Omnichannel Manager permission. By default, livechat managers and agents have this permission.)
Changelog
| Version | Description |
|---|---|
| 7.11.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example 1
{
"customFieldId": "class"
}object
customFieldId
string Required
Enter the custom field name that you want to delete.
Exampleclass
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Example 1
{
"success": false,
"errorType": "invalid-params",
"error": "must have required property 'customFieldId'"
}object
success
boolean
errorType
string
error
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Example 1
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}object
success
boolean
error
string