getSetupItems
Returns setup items on the account for a specified folder type.
Input parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| FolderType | integer | Yes | Related data item type. See output description under Return values below. |
Request format
curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/getSetupItems?auth=$authHash&FolderType=$FolderType"Return values
Parameters are provided in alphabetic order. See Sample code for probable output.
| Parameter | Type | Description |
|---|---|---|
| Data | JSON array | A JSON array of JSON objects with the mappings of fields to values. |
| AccessKey | string | Keyboard shortcut that inserts a canned message into an active chat. |
| AccountID | numeric - ID code | Bold360 product account. |
| Created | date - ISO/UTC | Date and time when the target resource was created. |
| Data | text - heading | JSON array heading that precedes report data output. |
| Deleted | date - ISO / UTC | Date and time when the item was deleted. The value is null if the item was not deleted. |
| DeletedBy | string (max) | The name of the agent who deleted the item. <None> or null value indicates that the <resource> was not deleted. |
| FolderID | numeric | The ID of the folder. |
| FolderType | integer | Related data item type:
|
| Internal | Boolean | Shows internal versus external initiation of a chat session. |
| IsActive | Boolean | Shows whether a resource (operator, department) is active or not. |
| Language | code - ISO 639 | Language preference and setting for the operator. |
| Name | string(30) | The name of the folder as defined in the system. |
| SetupItemID | numeric - ID | Canned message identifier. |
| Status | codes - set values | "Success" when the call completes; "Error" when the call fails. |
| Truncated | Boolean | TRUE if results were shortened to fit the report, FALSE if full results for the report criteria were returned. If TRUE, you can filter down the results set or contact us to try to find a way to get at the data you are looking for. |
| Updated | date - ISO / UTC | Date and time when the <event/record> was most recently modified. |
Sample code
{
"Status": "success",
"Truncated": false,
"Data": [
{
"SetupItemID": "445200406241354432",
"Name": "welcome",
"FolderType": 8,
"FolderID": null,
"AccountID": "447307266697849894",
"Created": "2020-09-25T13:57:08.023Z",
"Updated": "2020-09-25T13:57:08.023Z",
"Deleted": null,
"AccessKey": 196695,
"IsActive": 1,
"DeletedBy": null,
"Language": null,
"Internal": 0
}
]
}