Zoho crm Logo

签名邮件合并

目的

发送邮件合并文档以供签署和批准。

要使用此 API,您必须首先从 Writer UI 访问合并和Sign对话框。请注意,您只需执行此操作一次。

端点

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

请求详情

请求URL

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

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

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

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/554023000003128089/actions/sign_mail_merge"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"
-X POST
输入 JSON
  • mail_merge_template JSON 对象,必填
    • name 字符串,必填

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

  • file_name 字符串,必填

    您要发送进行签署和批准的文件名称。

  • sign_in_order 布尔值,可选

    值 true 表示文件将首先发送进行批准,然后进行签署。

  • signers JSON 数组,可选

    您希望签署文件的用户的详细信息。

    • recipient_name,字符串,必填 - 需要签署或批准文件的用户姓名。
    • action_type,字符串,必填 - 您希望用户执行的操作类型。可能的值是 sign 签署文件,和 approve 批准文件。
    • recipient,JSON 对象,必填
      • value,字符串,必填 - 需要签署或批准文件的用户的电子邮件 ID。

注意

  • 字段 "recipient_name" 和 "recipient.value" 的值将从邮件合并模板中获取。如果您想覆盖模板中的值,必须在输入正文中指定这些字段的值。

示例输入

Copied{
    "sign_mail_merge": [
        {
            "mail_merge_template": {
                "name": "mailmergename"
            },
            "file_name": "testdocument",
            "sign_in_order": true,
            "signers": [
                {
                    "recipient_name": "Smith",
                    "action_type": "sign",
                    "recipient": {
                        "type": "email",
                        "value": "smith@gmail.com"
                    }
                },
                {
                    "recipient_name": "John",
                    "action_type": "approve",
                    "recipient": {
                        "type": "email",
                        "value": "john@gmail.com"
                    }
                },
                {
                    "recipient_name": "John",
                    "action_type": "approve",
                    "recipient": {
                        "type": "merge_field",
                        "value": "${!Leads.Last_Name}"
                    }
                }
            ]
        }
    ]
}

可能的错误

  • EXPECTED_FIELD_MISSING HTTP 400

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

  • INVALID_DATAHTTP 400

    您指定的邮件合并模板名称不正确。
    解决方案:请提供正确的邮件合并模板名称。

  • INVALID_EMAILHTTP 400

    您为 "recipient" 字段指定了一个不正确的电子邮件地址。
    解决方法: 电子邮件 ID 必须仅属于组织批准的 CRM 用户或当前用户。

  • 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。

示例响应

Copied{
    "sign_mail_merge": [
        {
            "code": "SUCCESS",
            "details": {
                "sign_resource_id": "112953000000044001",
                "report_link": "https://writer.zoho.com/writer/v1/mailmerge/job/e1aee66cb489b8e89f8df4c8e36847ff2c1ec12b0b945e6f41314d5ca9a0870f710d651349ecdc916fbff687b9db8b3e"
            },
            "message": "send mail merge action initiated successfully",
            "status": "success"
        }
    ]
}