addChatIncident
Adds an incident - an event that occurs during a chat that requires review, follow-up, or tracking - to a specified chat record.
Input parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| ChatID | numeric - ID code | Yes | The chat to access or modify. |
| Url | string - legal URL | Yes | The URL to populate for this incident. |
| IncidentType | codes - set values | No | How the incident will appear to an agent. Values include:
|
| Name | string | No | The name of the tab shown to the agent for the incident before the tab is loaded, or if the document loaded has no title element. |
Request format
curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/addChatIncident?$auth=$authHash&chatID=$ChatID,Url=$https://[chat launch URL]>"Return values
| Parameter | Type | Description |
|---|---|---|
|
IncidentID |
numeric - ID code |
The unique identifier for the incident created. |