Zoho: Email templates schemas
7 Zoho schemas with complete fields and constraints.
← Email templates operations · All schemas
Email Templates — response body — Successful response for email templates retrieval
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Successful response for email templates retrieval Additional keys: not allowed |
email_templates | array | Required within parent | Represents the list of email templates matching the request criteria. Maximum items: 2000 |
email_templates[] | Model | Each item | Expand Email Templates — response body — Successful response for email templates retrieval email templates item |
info | Model | Required within parent | Expand Email Templates — response body — Successful response for email templates retrieval info |
Referenced models: Email Templates — response body — Successful response for email templates retrieval email templates item, Email Templates — response body — Successful response for email templates retrieval info
Email Templates — response body — Successful response for email templates retrieval email templates item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an Email Template in list view with summary information, including metadata, statistics, and association details. Additional keys: not allowed |
active | boolean | Required within parent | Indicates whether the Email Template is active. Possible values: **true** - The template is active. **false** - The template is inactive/deleted. |
associated | boolean | Required within parent | Indicates whether the Email Template is currently associated with one or more CRM components. Possible values: **true** - The template is associated with one or more CRM components. **false** - The template is not associated with any CRM component. |
attachments | JSON | Required within parent | |
attachments (anyOf 1) | array | Alternative | Represents the list of attachments associated with the Email Template. Maximum items: 10 |
attachments (anyOf 1)[] | Model | Each item | Expand Email Templates — response body — Successful response for email templates retrieval email templates item attachments null item |
attachments (anyOf 2) | null | Alternative | Represents the list of attachments associated with the Email Template. Maximum items: 10 |
attachments (anyOf 2)[] | Model | Each item | Expand Email Templates — response body — Successful response for email templates retrieval email templates item attachments null item |
category | string | Required within parent | Template category - normal, draft, marketplace, plugin, or default Known values: normal, draft, marketplace, plugin, system_templates |
consent_linked | boolean | Required within parent | Indicates whether this Email Template is linked to a consent form. Possible values: **true** - The template is linked to a consent form. **false** - The template is not linked to a consent form. |
created_by | Model | Required within parent | Expand Email Templates — response body — Successful response for email templates retrieval email templates item created by |
created_time | string | Required within parent | Represents the timestamp indicating when Zoho CRM created the Email Template. Format: date-time |
editor_mode | string | Required within parent | Represents the editor mode used to create the Email Template. Possible values: **plain_text** - The template uses plain text format. **rich_text** - The template uses rich text format. **gallery** - The template uses the gallery drag-and-drop editor. Known values: plain_text, rich_text, gallery |
favorite | boolean | Required within parent | Indicates whether the Email Template is marked as a favorite by the authenticated user. Possible values: **true** - The template is marked as a favorite. **false** - The template is not marked as a favorite. |
folder | Model | Required within parent | Expand Email Templates — response body — Successful response for email templates retrieval email templates item folder |
id | string | Required within parent | Represents the unique ID of the Email Template. Maximum length: 255 |
last_usage_time | JSON | Required within parent | |
last_usage_time (anyOf 1) | string | Alternative | Represents the timestamp indicating when the Email Template was last used. Format: date-time |
last_usage_time (anyOf 2) | null | Alternative | Represents the timestamp indicating when the Email Template was last used. Format: date-time |
last_version_statistics | object | Required within parent | Represents the email delivery and engagement statistics from the most recent version of the template. Additional keys: not allowed |
last_version_statistics.bounced | JSON | Required within parent | |
last_version_statistics.bounced (anyOf 1) | integer | Alternative | Represents the number of emails that bounced when sent using this template. Format: int32 |
last_version_statistics.bounced (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
last_version_statistics.clicked | JSON | Required within parent | |
last_version_statistics.clicked (anyOf 1) | integer | Alternative | Represents the number of link clicks recorded in emails sent using this template. Format: int32 |
last_version_statistics.clicked (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
last_version_statistics.delivered | JSON | Required within parent | |
last_version_statistics.delivered (anyOf 1) | integer | Alternative | Represents the number of emails delivered successfully when sent using this template. Format: int32 |
last_version_statistics.delivered (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
last_version_statistics.opened | JSON | Required within parent | |
last_version_statistics.opened (anyOf 1) | integer | Alternative | Represents the number of emails opened by recipients when sent using this template. Format: int32 |
last_version_statistics.opened (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
last_version_statistics.sent | JSON | Required within parent | |
last_version_statistics.sent (anyOf 1) | integer | Alternative | Represents the total number of emails sent using this template. Format: int32 |
last_version_statistics.sent (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
last_version_statistics.tracked | JSON | Required within parent | |
last_version_statistics.tracked (anyOf 1) | integer | Alternative | Represents the number of emails sent using this template for which tracking is enabled. Format: int32 |
last_version_statistics.tracked (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
modified_by | Model | Required within parent | Expand Email Templates — response body — Successful response for email templates retrieval email templates item created by |
modified_time | string | Required within parent | Represents the timestamp indicating when the Email Template was last modified. Format: date-time |
module | Model | Required within parent | Expand Email Templates — response body — Successful response for email templates retrieval email templates item module |
name | string | Required within parent | Represents the display name of the Email Template. Maximum length: 75 |
subject | string | Required within parent | Represents the email subject line of the template. Maximum length: 250 |
Referenced models: Email Templates — response body — Successful response for email templates retrieval email templates item folder, Email Templates — response body — Successful response for email templates retrieval email templates item module, Email Templates — response body — Successful response for email templates retrieval email templates item created by, Email Templates — response body — Successful response for email templates retrieval email templates item attachments null item
Email Templates — response body — Successful response for email templates retrieval email templates item attachments null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an attachment entry associated with the Email Template. Additional keys: not allowed |
file_id | string | Required within parent | Represents the unique ID of the attachment file in the Zoho CRM file store. Maximum length: 255 |
file_name | string | Required within parent | Represents the name of the attachment file. Maximum length: 255 |
id | string | Required within parent | Represents the unique ID of the attachment entry. Maximum length: 255 |
size | string | Required within parent | Represents the size of the attachment file. Maximum length: 255 |
Email Templates — response body — Successful response for email templates retrieval email templates item created by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a reference to the Zoho CRM user associated with the Email Template. Additional keys: not allowed |
id | string | Required within parent | Represents the unique ID of the user. Maximum length: 255 |
name | string | Required within parent | Represents the display name of the user. Maximum length: 255 |
Email Templates — response body — Successful response for email templates retrieval email templates item folder
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a reference to the folder in which the Email Template is stored. Additional keys: not allowed |
id | string | Required within parent | Represents the unique ID of the folder. Maximum length: 255 |
name | string | Required within parent | Represents the display name of the folder. Maximum length: 255 |
Email Templates — response body — Successful response for email templates retrieval email templates item module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a reference to the CRM module associated with the Email Template. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the module. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values. Maximum length: 255 |
id | string | Required within parent | Represents the unique ID of the module. Maximum length: 255 |
Email Templates — response body — Successful response for email templates retrieval info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the pagination metadata for the email templates list response. Additional keys: not allowed |
count | JSON | Required within parent | |
count (anyOf 1) | integer | Alternative | Represents the number of Email Template records returned in the current page. Format: int32 |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
more_records | boolean | Required within parent | Indicates whether additional pages of results are available. Possible values: **true** - More records are available on subsequent pages. **false** - The current page contains the last available records. |
page | JSON | Required within parent | |
page (anyOf 1) | integer | Alternative | Represents the current page number of the paginated response. Format: int32 |
page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
per_page | JSON | Required within parent | |
per_page (anyOf 1) | integer | Alternative | Represents the number of Email Template records returned per page. Format: int32 |
per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |