Public Canned Message Category

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

Public Canned Message Categories
- Public Canned Message Categories Manage
GET global/publicCannedMessageCategories
GET global/publicCannedMessageCategories/{id}
POST global/publicCannedMessageCategories
PUT global/publicCannedMessageCategories/{id}
DELETE global/publicCannedMessageCategories/{id}
Model
Public Canned Message Category JSON Format

Public Canned Message Category 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 Public Canned Message Categories

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":"c16a998b-8b34-47f2-9dbc-95779c0ae175","name":"Live Chat","parentId":"97AF5329-7C46-EB11-8100-00155D081D0C","order":1}]
Get a single Public Canned Message Category

GET global/publicCannedMessageCategories/{id}

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/global/publicCannedMessageCategories/c16a998b-8b34-47f2-9dbc-95779c0ae175 \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"c16a998b-8b34-47f2-9dbc-95779c0ae175","name":"Live Chat","parentId":"97AF5329-7C46-EB11-8100-00155D081D0C","order":1}
Create a new Public Canned Message Category

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":"c16a998b-8b34-47f2-9dbc-95779c0ae175","name":"Live Chat","parentId":"97AF5329-7C46-EB11-8100-00155D081D0C","order":1}
Update the Public Canned Message Category

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/c16a998b-8b34-47f2-9dbc-95779c0ae175 \
-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":"c16a998b-8b34-47f2-9dbc-95779c0ae175","name":"Live Chat","parentId":"97AF5329-7C46-EB11-8100-00155D081D0C","order":1}
Remove the Public Canned Message Category

DELETE global/publicCannedMessageCategories/{id}

Parameters:
No Parameters
Response:

No Content

Example

Sample Request:

curl https://api15.comm100.io/v4/global/publicCannedMessageCategories/c16a998b-8b34-47f2-9dbc-95779c0ae175 \
-X 'DELETE' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 204 No Content