Your use case. Our milestone. The 200th post in our "Kaizen Series: Continuous Improvement for Developer Experience" is coming up. Share Now

X
Skip to main content

Email Templates

Purpose

To fetch the email templates in a module.

Request Details

Request URL

All - {api-domain}/crm/{version}/settings/email_templates
Specific - {api-domain}/crm/{version}/settings/email_templates/{id}

Header

Authorization: Zoho-oauthtoken <access_token>

Scope

scope=ZohoCRM.templates.email.READ

Parameters
  • modulestring

    The API name of the module you want to fetch email template from. Supported modules are:
    Leads, Accounts, Contacts, Deals, Tasks, Events, Calls, Products, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Campaigns, Vendors, Cases, Solutions, and Custom.

Note
  • The content key contains the HTML of the email template and is rendered in the response only when you fetch a specific email template.

Sample Request

Copied

Response JSON Keys

  • created_timestring

    Represents the date and time at which the email template was created.

  • attachmentsJSON array

    Represents the attachments added in the template.

  • subjectstring

    Represents the subject of the email template.

  • moduleJSON object

    Represents the module with which the template is associated with.

  • created_byJSON object

    Represents the name and ID of the user who created the email template.

  • layoutJSON object

    Represents the layout the template is associated with.

  • modified_timestring

    Represents the date and time at which the email template was last modified.

  • folderJSON object

    Represents the name and unique ID of the template folder.

  • last_usage_timestring

    Represents the date and time at which the email template was last used.

  • associatedboolean

    Represents whether the template is associated or not.

  • namestring

    Represents the name of the email template.

  • consent_linkedboolean

    Represents whether the consent form is linked with the template.

  • modified_byJSON object

    Represents the name and ID of the user who last modified the email template.

  • idstring

    Represents the unique ID of the email template.

  • editor_modestring

    Represents the mode in which the email template is created. The possible values are gallery: the template is chosen from the template gallery and is customized, rich_text: a pre-designed custom template, plain_text: the template is built from scratch.

  • categorystring

    Represents the type of the template. The possible values are custom_templates: the templates created by a user, system_templates: the templates present in the system by default, plugin_templates: the templates that are created and installed from the Zoho CRM extension, marketplace_templates: the templates that are created and installed from the published plugins.

  • favoriteboolean

    Represents if the email template is marked as favorite.

Possible Errors

  • BAD_REQUESTHTTP 400

    The request method specified is invalid.
    Resolution: Specify the request method as GET.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    The token does not have the scope ZohoCRM.templates.email.READ.
    Resolution: Create a token with the scope ZohoCRM.templates.email.READ.

  • NO_PERMISSIONHTTP 403

    You do not have the permission to read the email templates.
    Resolution: Contact your administrator.

  • INVALID_URL_PATTERNHTTP 404

    The request URL has syntactical errors.
    Resolution: Correct the syntactical errors in the request URL.

Sample Response

Copied