DocuSign REST API：添加具有文档可见性的抄送收件人

Question

我可以使用 REST API 成功地将收件人添加到现有的 DocuSign 信封中。当我将签名者添加到信封时，我还可以使用 excludedDocuments 元素指定文档可见性。但是，我无法使用此参数为抄送收件人设置文档可见性。我的业务需求是一个抄送收件人不应收到信封中的部分文件。

下面是我的JSON请求：

{
  "carbonCopies": [
    {
      "email": "123@hotmail.com",
      "excludedDocuments": [
        "1"
      ],
      "name": "testCC1",
      "recipientId": "5"
    }
  ],
  "signers": [
    {
      "email": "123@gmail.com",
      "excludedDocuments": [
        "1"
      ],
      "name": "ssgmail signer",
      "recipientId": "7"
    }
  ]
}

以上两个收件人都添加成功。第一个收件人（签名者）设置正确，文档 1 不可见。第二个收件人（抄送）设置为完全可见。

有趣的是，我可以转到 DocuSign 界面并更正信封以删除抄送收件人的可见性。所以我认为 DocuSign 确实支持此功能。

知道如何使用 rest/soap add/change 现有信封的抄送收件人的个人文档的可见性 API？

注：-

坦率地说，我不知道如何使用 API 查询 envelope/recipient 中的文档可见性。为此，我转到正确的信封屏幕中的 "View/Modify Document Visibility" link 以检查当前的可见性设置。
我已将文档可见性设置为 "Must Sign to View Unless Sender Account" 以启用文档可见性功能。

Answer 1

您在 JSON 请求 "enforceSignerVisibility":true 中遗漏了一个属性，我有以下请求可以与 DocumentVisibility 一起正常工作：

{
  "documents": [
    {
      "documentBase64": "<Base64>",
      "documentId": "1",
      "fileExtension": "docx",
      "name": "Challenge3"
    },
    {
      "documentBase64": "<Base64>",
      "documentId": "2",
      "fileExtension": "docx",
      "name": "Challenge4"
    }
  ],
  "emailSubject": "Test Subject",
  "recipients": {
    "signers": [
      {
        "email": "Signer@gmail.com",
        "name": "Signer",
        "recipientId": "2",
        "routingOrder":1,
        "excludedDocuments":[2],
        "tabs": {
          "signHereTabs": [
            {
              "documentId": "1",
              "recipientId": "1",
              "xPosition": "300",
              "yPosition": "300",
              "pageNumber":1
            }
          ]
        }
      }
    ],
    "carbonCopies": [
      {
        "email": "CC@gmail.com",
        "name": "CC",
        "recipientId": "1",
        "routingOrder":1,
        "excludedDocuments":[1]
      }
    ]
  },
  "status": "sent",
  "enforceSignerVisibility":true
}

DocuSign REST API：添加具有文档可见性的抄送收件人

DocuSign REST API: Adding a Carbon Copy Recipient With Document Visibility

rest

email

docusignapi

carbon-copy