FoyerDevelopers

Generated · Live registry

cannedResponses tools

5 tools in this domain, generated from the running registry.

All tool domains

cannedResponses.create

writes

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

FieldTypeRequiredNotes
namestringyes
categorystringno
messagestringyes
tagsarray of stringno

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
categorystringyes
messagestringyes
tagsarray of stringyes
usageCountintegeryes
createdAtstringyes
updatedAtstringyes

cannedResponses.delete

writesconfirm

Delete a canned response template.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
okbooleanyes

cannedResponses.get

read-only

Returns a canned response (quick reply) by its id. Any signed-in role. Read-only; an unknown id results in NOT_FOUND.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
categorystringyes
messagestringyes
tagsarray of stringyes
usageCountintegeryes
createdAtstringyes
updatedAtstringyes

cannedResponses.list

read-only

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:

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
categorystringyes
messagestringyes
tagsarray of stringyes
usageCountintegeryes
createdAtstringyes
updatedAtstringyes

cannedResponses.update

writes

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

FieldTypeRequiredNotes
idstringyes
namestringno
categorystringno
messagestringno
tagsarray of stringno

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
categorystringyes
messagestringyes
tagsarray of stringyes
usageCountintegeryes
createdAtstringyes
updatedAtstringyes