Set Custom Indicator

Prev Next
Post
/objects/{OBJECT_ID}/indicators

This API sets an icon at the top of the conversation page to give an indication to the agent about the customer or the conversation.
When the agent hovers over it, the title appears, and when the agent clicks on it, it can open a link (optional settings).

See Schema for details.

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
OBJECT_ID
Required

Object ID. This is a commbox generated number for the conversation

Body parameters

Optional description for new mail object in Markdown

Expand All
object
data
object
IndicatorId
string

Enter a name for the icon. This name (ID) is required when you want to delete this icon

Examplehome
Title
string

Enter the wording that will appear once the user hovers over the icon

ExampleWorking from home
DisplayClass
string

Enter the icon name as it appears in icomoon.io site, with the 'icon-' heading

Exampleicon-home
Link
string

(Optional) Enter a link that will open when the user clicks on the icon

Examplewww.commbox.io
Responses
200

OK

object
status
string
Example200
description
string
ExampleOperation successful
response_time
string
Example2024-08-06T07:51:52.2581942Z
data
string
Example
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