如何通过API调用DocuSign账户配置的邮件功能实现自动签署请求

1. 确认账户配置的可用性 #

先确保你在DocuSign后台配置的邮件品牌化、提醒规则、过期设置已经生效——这些账户级配置会作为默认值，API调用时只要不主动覆盖，就会自动沿用。

2. 获取API授权 #

通过OAuth 2.0获取访问令牌，这是调用DocuSign API的必要凭证。根据应用场景选择合适的授权流程：

• 服务器端应用用授权码流程
• 无人值守的自动场景用JWT流程

3. 构造签署请求API Payload #

调用envelopes.create接口时，重点处理以下部分：

• 保留账户默认配置：不要在Payload中设置emailSettings下的brandId、reminders、expirations字段，DocuSign会自动调用你账户里已配置的对应规则。
• 自定义邮件正文：在recipients数组的签署人对象中，设置emailNotification的emailBody字段，填入你需要的自定义正文；如果所有签署人用同一段正文，也可以在emailSettings里设置emailBody（注意不要覆盖其他默认配置）。
• 基础必填信息：必须包含status: "sent"（直接发送信封），以及文档、签署人等核心信息。

示例Payload片段 #

{
  "status": "sent",
  "emailSubject": "请签署指定文档", // 可留空使用账户默认主题，也可自定义
  "documents": [
    {
      "documentBase64": "base64编码的文档内容",
      "name": "待签署协议.pdf",
      "documentId": "1"
    }
  ],
  "recipients": {
    "signers": [
      {
        "email": "signer@example.com",
        "name": "签署人姓名",
        "recipientId": "1",
        "emailNotification": {
          "emailBody": "这是通过API自定义的邮件正文，品牌样式、提醒及过期规则将使用账户配置。"
        }
      }
    ]
  }
}

4. 发送API请求 #

将构造好的Payload通过POST请求发送至对应环境的API端点：

• 沙箱环境：https://demo.docusign.net/restapi/v2.1/accounts/{accountId}/envelopes
• 生产环境：https://www.docusign.net/restapi/v2.1/accounts/{accountId}/envelopes
  请求头需携带Authorization: Bearer {access_token}和Content-Type: application/json。

5. 验证执行结果 #

发送后可通过envelopes.get接口查询信封状态，同时检查签署人收到的邮件：确认邮件使用了账户配置的品牌样式，后续的提醒、过期规则按账户设置自动执行，且正文为API指定内容。

内容的提问来源于stack exchange，提问作者Nadia