Sign in

v51

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-01121113461.4 KB
mailboxes

Retrieve a message template.

get/api/v1.0/mailboxes/{mailbox_id}/message-templates/{id}/

Path parameters

idstring required
mailbox_idstring uuid required

Query parameters

bodiesstring

Comma-separated list of body fields to include in the response. Allowed values: raw, html, text. Example: ?bodies=raw,html

Response

idstring uuid required

primary key for the record as UUID

namestring required

Name of the template (e.g., 'Standard Reply', 'Out of Office', 'Work Signature')

html_bodystring nullable
text_bodystring nullable
raw_bodystring nullable
type'message' | 'signature' | 'autoreply' required
is_activeboolean required

Whether this template is available for use

is_forcedboolean required

Whether this template is forced; no other template of the same type can be used in the same scope

is_defaultboolean required

Whether this template is the default; it will be automatically loaded when composing a new message

metadataobject
signaturestring uuid required

primary key for the record as UUID

is_active_autoreplyboolean nullable required
created_atstring date-time required

date and time at which a record was created

updated_atstring date-time required

date and time at which a record was last updated