Zoho crm Logo

下载邮件合并

目的

使用下载邮件合并API来下载使用您的邮件合并模板创建的合并文档。

端点

  • POST /{module_API_name}/{record_id}/actions/download_mail_merge

Request 详情

Request URL

{api-domain}/crm/{version}/{module_API_name}/{record_id}/actions/download_mail_merge

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

scope=ZohoCRM.settings.mailmerge.CREATE,ZohoWriter.documentEditor.ALL,ZohoWriter.merge.ALL

样本请求

在请求中,“@input.json”包含了样本输入数据。 

输入 JSON
  • mail_merge_templateJSON对象,必填
    • name 字符串,必填

      您想要使用的邮件合并模板的名称。

  • output_format字符串,可选

    您希望文档的格式。这可以是pdf,html或docx。默认格式将是pdf。

  • file_name字符串,可选

    您希望文档的文件名。默认值将是"download"。file_name的最大大小为255个字符。

  • password字符串,可选

    文档的密码。当输出格式为pdf时,此项适用。

注意

  • 此api可以支持最长1分钟的合并处理时间。
  • 此api消耗5个积分。如果失败,它将消耗1个积分

 

样本输入

可能的错误

  • EXPECTED_FIELD_MISSINGHTTP 400

    您没有在"mail_merge_template"键中指定名称。
    解决方案:您必须在"mail_merge_template"键中指定邮件合并模板的名称。

  • INVALID_DATAHTTP 400
    • 您指定的邮件合并模板名称不正确。
    • 您提供的输出格式无效。
    • 您提供的文件名长度超过255个字符。

    解决方案:请参考响应中的"details"键,找出输入中有错误的字段的API名称并进行更正。

     

  • INVALID_DATAHTTP 400

    您在URL中指定的记录ID不正确。
    解决方案:在URL中提供正确的记录ID。使用获取记录API来获取记录ID。

  • .

    INVALID_MODULEHTTP 400

    模块名称无效。
    解决方案: 使用模块API获取模块的API名称。

  • MANDATORY_NOT_FOUNDHTTP 400

    您在请求中没有指定一个或多个必需的键。
    解决方案:请参考输入JSON部分,查看必需键的列表。

  • INVALID_REQUEST_METHODHTTP 400

    HTTP请求方法无效。
    解决方案:此API的HTTP请求方法是POST。

  • INTERNAL_ERRORHTTP 500

    服务器中未处理的异常。
    解决方案:联系support@zohocrm.com的支持团队。

  • DEPENDENT_SERVICE_ERRORHTTP 400

    文档处理时间超过1分钟。
    解决方案:您可以在模板中进行更改,如压缩图像,这将减小文件大小,从而缩短处理时间。