Zoho crm Logo

将电子邮件与记录关联

Zoho CRM允许其用户将电子邮件与记录实体关联。您还可以将电子邮件条目与记录关联,并将另一条记录映射到相同的记录。例如,如果您正在将电子邮件关联到交易,您可能还需要将联系人与其映射。这是通过使用关联电子邮件API来实现的。

目的

在Zoho CRM中将电子邮件与记录实体关联。

端点

  • POST /{module_API_name}/{entity_ID}/actions/associate_email

Request 详情

Request URL

{api-domain}/crm/{version}/{module_API_name}/{record_ID}/actions/associate_email

支持的模块

潜在客户,联系人,报价,发票,销售订单,采购订单,交易,账户和自定义

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.modules.emails.ALL
(并且)
ZohoCRM.modules.{module}.ALL

可能的模块

潜在客户,联系人,报价,发票,销售订单,采购订单,交易,账户和自定义模块。

样本请求

输入 JSON

  • fromJSON 对象,必填

    代表电子邮件的发送者。该对象包括 user_name 和 email。

  • 至JSON 数组,必填

    代表电子邮件的收件人。数组中的每个对象都包括 user_name 和 email。

  • 主题字符串,必填

    代表电子邮件的主题行。

  • 内容字符串,必填

    代表电子邮件正文内容。

  • date_timeDateTime,必填

    发送电子邮件的日期和时间。

  • sent Boolean,必填

    表示邮件是已发送还是已接收。 
    可能的值:
    true - 邮件已发送。
    false -  邮件已接收。

  • original_message_id字符串,必填

    代表来自电子邮件头的唯一消息ID。

  • ccJSON 数组,可选

    代表抄送给关联电子邮件的用户。对象由 user_name 和 email 组成。

  • bccJSON 数组,可选

    代表以密送方式发送相关邮件的用户。该对象由 user_name 和 email 组成。

  • mail_format字符串,可选

    代表相关电子邮件的格式。可能的值是html。

  • 附件JSON 数组,可选

    包括电子邮件中附件的详细信息。每个对象都包含id和file_name。id代表将文件上传到ZFS后的文件ID。请参考上传文件文档以获取更多详细信息。请注意,附件文件的总大小限制为10MB。

  • linked_recordJSON 对象,可选

    将电子邮件映射到额外的实体。此对象包含实体的 id 和 name,以及模块详细信息。

样本输入

Request格式用于带有内联图像的内容

如果您希望关联的电子邮件内容包含内联图像,您应该将图像上传到ZFS,并使用参数type=inline。应在输入体的content部分使用响应中的文件ID。有关更多详细信息,请查看右侧的样本输入部分。

样本输入,内容包含内联图片

Request格式,用于具有管理员角色的用户关联其他用户的邮件

管理员用户可以将其他用户的电子邮件与任何记录关联。请注意,只有具有管理员权限的用户才能将另一个用户的电子邮件与记录关联。您需要提供一个额外的输入键来表示电子邮件的所有者。

输入 JSON

  • 所有者JSON 对象,如果关联其他用户的电子邮件,则必须。

    代表电子邮件的所有者。

管理员用户关联其他用户邮件的示例输入

可能的错误

  • INVALID_REQUEST_METHODHTTP 400

    请求方法不正确。
    解决方案: 使用HTTP POST 方法来进行此API调用。任何其他请求方法都会导致此错误。

  • FILE_SIZE_EXCEEDSHTTP 400

    总文件大小不应超过10MB。文件大小超过了这个限制。
    解决方案:将总附件文件大小限制为10MB。

  • DUPLICATE_DATAHTTP 400

    您指定的消息ID已与记录关联。 
    解决方案:为original_message_id键指定另一个有效的消息ID。

  • INVALID_DATAHTTP 400
    • 您指定的附件ID无效。
      解决方案:指定一个有效的附件ID。
    • 您指定的所有者ID无效。 
      解决方案:提供一个有效的所有者ID。
    • 您为链接记录指定的记录ID无效。
      解决方案:提供一个有效的记录ID。
    • 您为linked_records值指定的模块API名称无效。
      解决方案:在linked_records键中指定一个有效且受支持的模块API名称。
  • MANDATORY_NOT_FOUNDHTTP 400

    您没有在输入的JSON中指定一个或多个必需的键。 
    解决方案:请参考本页开头的输入JSON部分,并指定所有必需的键。

  • INVALID_MODULEHTTP 400

    您试图将电子邮件与不受支持的模块关联。 
    解决方案:请查看上方的支持的模块部分,了解哪些模块受支持,并将电子邮件与受支持的模块实体关联。

  • STORAGE_SPACE_EXCEEDSHTTP 400

    您已超出了您的Zoho CRM Org的存储空间。 
    解决方案:请联系您的管理员。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    您用来进行此API调用的访问令牌没有所需的范围。
    解决方案:生成具有此API所需范围的新访问令牌。请参阅此页面开头的范围部分,以获取所需范围的列表。

  • NO_PERMISSIONHTTP 403

    只有管理员角色/配置文件用户才有权限
    解决方案:联系您的系统管理员。

  • INVALID_URL_PATTERNHTTP 404

    请求的URL不正确。
    解决方案:指定一个有效的请求URL。请参考本页开头的请求URL部分以获取更多详细信息。

  • INTERNAL_ERRORHTTP 500

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

样本回应