Global_PublicCannedMessageCategory

You need Manage Public Canned Messages permission to manage the public canned message categories.

Global_PublicCannedMessageCategories
- Global_PublicCannedMessageCategories Manage
GET global/publicCannedMessageCategories
GET global/publicCannedMessageCategories/{id}
POST global/publicCannedMessageCategories
PUT global/publicCannedMessageCategories/{id}
DELETE global/publicCannedMessageCategories/{id}
Model
Global_PublicCannedMessageCategory JSON Format

Global_PublicCannedMessageCategory is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the canned message category.
name string Name of the canned message category.
parentId guid Parent of the canned message category.
order integer Order of the canned message category.
Endpoint
Get the list of Global_PublicCannedMessageCategories

GET global/publicCannedMessageCategories

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/global/publicCannedMessageCategories \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"id":"188f4225-6ac0-46f2-a87a-73b36ca0c6f9","name":"Live Chat","parentId":"97AF5329-7C46-EB11-8100-00155D081D0C","order":1}]
Get a single Global_PublicCannedMessageCategory

GET global/publicCannedMessageCategories/{id}

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/global/publicCannedMessageCategories/188f4225-6ac0-46f2-a87a-73b36ca0c6f9 \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"188f4225-6ac0-46f2-a87a-73b36ca0c6f9","name":"Live Chat","parentId":"97AF5329-7C46-EB11-8100-00155D081D0C","order":1}
Create a new Global_PublicCannedMessageCategory

POST global/publicCannedMessageCategories

Parameters:
Name Type In Required Description
name string body yes Name of the canned message category.
parentId guid body yes Parent of the canned message category.
order integer body no Order of the canned message category.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/global/publicCannedMessageCategories \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"name":"Live Chat","parentId":"97AF5329-7C46-EB11-8100-00155D081D0C","order":1}'

Response:

 HTTP/1.1 201 Created

{"id":"188f4225-6ac0-46f2-a87a-73b36ca0c6f9","name":"Live Chat","parentId":"97AF5329-7C46-EB11-8100-00155D081D0C","order":1}
Update the Global_PublicCannedMessageCategory

PUT global/publicCannedMessageCategories/{id}

Parameters:
Name Type In Required Description
name string body yes Name of the canned message category.
parentId guid body yes Parent of the canned message category.
order integer body no Order of the canned message category.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/global/publicCannedMessageCategories/188f4225-6ac0-46f2-a87a-73b36ca0c6f9 \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"name":"Live Chat","parentId":"97AF5329-7C46-EB11-8100-00155D081D0C","order":1}'

Response:

 HTTP/1.1 200 OK

{"id":"188f4225-6ac0-46f2-a87a-73b36ca0c6f9","name":"Live Chat","parentId":"97AF5329-7C46-EB11-8100-00155D081D0C","order":1}
Remove the Global_PublicCannedMessageCategory

DELETE global/publicCannedMessageCategories/{id}

Parameters:
No Parameters
Response:

No Content

Example

Sample Request:

curl https://api15.comm100.io/v4/global/publicCannedMessageCategories/188f4225-6ac0-46f2-a87a-73b36ca0c6f9 \
-X 'DELETE' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 204 No Content