DocuSign REST API:添加具有文档可见性的Carbon Copy收件人

时间:2017-11-04 16:34:58

标签: rest email docusignapi carbon-copy

我可以使用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 API添加/更改现有信封的抄送收件人的单个文档的可见性?

注意: -

  1. 坦率地说,我不知道如何使用API​​查询信封/收件人的文档可见性。为此,我转到"查看/修改文档可见性"链接在正确的信封屏幕中以检查当前的可见性设置。

  2. 我已将文档可见性设置为"必须签名才能查看发件人帐户"启用文档可见性功能。

1 个答案:

答案 0 :(得分:2)

您在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
}