Canned Responses

Predefined message templates

EndpointsCopy Anchor Link

• POST Create a localized canned response — Creates a reusable response in a category owned by the authenticated organization.
• POST Create a localized canned response category — Creates a category for grouping canned responses in the authenticated organization. At least one localized name is required.
• DELETE Delete a canned response — Permanently deletes a canned response together with its translations and shortcuts. Existing conversation messages created from the response are unchanged.
• DELETE Delete a canned response category — Permanently deletes a canned-response category. If the category still contains responses, moveToCategoryId must identify another category in the same…
• GET List canned responses resolved for a locale — Returns a paginated list of canned responses resolved for the requested locale.
• GET List localized canned response categories — Returns every canned-response category in the authenticated organization, resolved for the requested locale and ordered by sort position.
• POST Record canned response usage — Increments a canned response's usage count and updates its last-used timestamp. The response must belong to the authenticated organization.
• POST Reorder canned responses — Applies explicit sort positions to up to 500 canned responses in one transaction. Every referenced response must belong to the authenticated organization.
• PATCH Update a localized canned response — Partially updates a canned response in the authenticated organization.
• PATCH Update a localized canned response category — Partially updates a canned-response category's key, sort order, or localized names. Omitted fields remain unchanged.