Zoho crm Logo

电子邮件模板

目的

在模块中获取电子邮件模板。

请求详情

Request URL

全部 - {api-domain}/crm/{version}/settings/email_templates
特定的 - {api-domain}/crm/{version}/settings/email_templates/{id}

Header

授权:Zoho-oauthtoken <access_token>

范围

scope=ZohoCRM.templates.email.READ

  • GET /settings/email_templates
  • GET /settings/email_templates/{template_id}
参数
  • 模块字符串

    您想要从中获取电子邮件模板的模块的API名称。支持的模块包括:
    潜在客户,账户,联系人,交易,任务,事件,呼叫,产品,价格书,报价,销售订单,采购订单,发票,活动,供应商,案例,解决方案,以及自定义。

注意

  • 内容键包含电子邮件模板的HTML,并且只有在获取特定电子邮件模板时才在响应中呈现。

样本请求

Response JSON 键

  • created_timestring

    代表创建电子邮件模板的日期和时间。

  • 附件JSON 数组

    代表在模板中添加的附件。

  • 主题字符串

    代表电子邮件模板的主题。

  • 模块JSON 对象

    表示与模板关联的模块。

  • created_byJSON 对象

    代表创建电子邮件模板的用户的名称和ID。

  • 布局JSON 对象

    代表模板关联的布局。

  • modified_timestring

    表示电子邮件模板最后修改的日期和时间。

  • 文件夹JSON 对象

    代表模板文件夹的名称和唯一ID。

  • last_usage_timestring

    表示邮件模板最后使用的日期和时间。

  • associated布尔值

    表示模板是否已关联。

  • namestring

    代表电子邮件模板的名称。

  • consent_linked布尔值

    表示同意表单是否与模板链接。

  • modified_byJSON 对象

    代表最后修改电子邮件模板的用户的名称和ID。

  • idstring

    代表电子邮件模板的唯一ID。

  • editor_mode字符串

    表示创建电子邮件模板的模式。可能的值有 gallery: 从模板库中选择模板并进行定制,rich_text: 预设计的自定义模板,plain_text: 从零开始构建的模板。

  • categorystring

    代表模板的类型。可能的值有 正常,草稿:处于草稿状态的模板,系统模板:系统默认存在的模板,插件模板:从Zoho CRM扩展创建和安装的模板,市场模板:从发布的插件创建和安装的模板。

  • last_version_statisticsJSON 对象

    使用此模板的统计数据,例如打开、跟踪、发送、弹回等电子邮件的数量。

  • favoriteboolean

    表示电子邮件模板是否被标记为收藏。

可能的错误

  • BAD_REQUESTHTTP 400

    指定的请求方法无效。
    解决方案:将请求方法指定为GET。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    令牌没有ZohoCRM.templates.email.READ的范围。
    解决方案:创建一个具有ZohoCRM.templates.email.READ范围的令牌。

  • NO_PERMISSIONHTTP 403

    您没有权限读取电子邮件模板。
    解决方案:联系您的管理员。

  • INVALID_URL_PATTERNHTTP 404

    请求URL存在语法错误。
    解决方案:纠正请求URL中的语法错误。

样本回应