You need Manage Private Canned Messages permission to manage the private canned message categories.
Global_PrivateCannedMessageCategory 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. |
createdById |
guid | Id of the agent who create the canned message category. |
order |
integer | Order of the canned message category. |
GET global/privateCannedMessageCategories
Sample Request:
Response:
HTTP/1.1 200 OK
GET global/privateCannedMessageCategories/{id}
Sample Request:
Response:
HTTP/1.1 200 OK
POST global/privateCannedMessageCategories
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. |
createdById |
guid | body | no | Id of the agent who create the canned message category. |
order |
integer | body | no | Order of the canned message category. |
Sample Request:
Response:
HTTP/1.1 201 Created
PUT global/privateCannedMessageCategories/{id}
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. |
createdById |
guid | body | no | Id of the agent who create the canned message category. |
order |
integer | body | no | Order of the canned message category. |
Sample Request:
Response:
HTTP/1.1 200 OK
DELETE global/privateCannedMessageCategories/{id}
No Content
Sample Request:
Response:
HTTP/1.1 204 No Content