cannedResponses.create
Creates a new canned response for replies to guests (name, message, optional category and tags). Owner only. Changes data; a name that is already taken results in CONFLICT. Mutation — changes data.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
name | string | yes | |
category | string | no | |
message | string | yes | |
tags | array of string | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
name | string | yes | |
category | string | yes | |
message | string | yes | |
tags | array of string | yes | |
usageCount | integer | yes | |
createdAt | string | yes | |
updatedAt | string | yes |
cannedResponses.delete
Delete a canned response template.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | boolean | yes |
cannedResponses.get
Returns a canned response (quick reply) by its id. Any signed-in role. Read-only; an unknown id results in NOT_FOUND.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
name | string | yes | |
category | string | yes | |
message | string | yes | |
tags | array of string | yes | |
usageCount | integer | yes | |
createdAt | string | yes | |
updatedAt | string | yes |
cannedResponses.list
Lists the canned responses (quick replies for guest messages: name, category, text, tags, usage counter), sorted by category and name. Any signed-in role. Read-only.
Input parameters
Returns object.
Output fields
Returns array of object. Fields of each element:
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
name | string | yes | |
category | string | yes | |
message | string | yes | |
tags | array of string | yes | |
usageCount | integer | yes | |
createdAt | string | yes | |
updatedAt | string | yes |
cannedResponses.update
Partially updates a canned response (id): name, category, text or tags. Owner only. Changes data; an unknown id results in NOT_FOUND. Mutation — changes data.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
name | string | no | |
category | string | no | |
message | string | no | |
tags | array of string | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
name | string | yes | |
category | string | yes | |
message | string | yes | |
tags | array of string | yes | |
usageCount | integer | yes | |
createdAt | string | yes | |
updatedAt | string | yes |