Docusign不允许我将收件人添加到模板

时间:2019-06-19 03:37:29

标签: docusignapi

我在UI上创建了一个模板,并上传了一个文档。然后,我从用户界面添加了一个收件人,并在文档中映射了一些字段。

我想基于此模板创建一个信封,并在发送签名之前填充一些字段。想法是,我们有一个门户,用户可以在其中填写表格,然后将文档发送给他进行签名。

正在查看docs here。我应该像这样发送并填充它:

{
    ...
    "templateId": "68a89cdc-xxxx-xxxx-xxxx-fa2ab60713e3",
    "recipients": {
        "signers": [
            {
                ...
                "name": "Example Name",
                "email": "examplename@example.com", 
                "roleName": "Signer One",
            }
        ]
    ...
    },

...
}

但是这给了我一个错误:

Status: 400  INVALID_REQUEST_PARAMETER: The request contained at least one invalid parameter. 'recipients' may not be specifed when 'templateId' is set. Use 'templateRoles'.

我按照建议继续使用templateRoles

{
    "accountId": "301424",
    "emailSubject": "API Example - Populating Data in Templates",
    "templateId": "44D9E888-xxxx-xxxx-xxxx-7071BC87A0DA",
    "templateRoles": [{
        "email": "john.doe@email.com",
        "name": "John Doe",
        "roleName": "Customer",
        "tabs": {
            "textTabs": [{
                "tabLabel": "CustomerAddress",
                "value": "123 Main St. San Francisco, CA 94105"
            }, 
            {
                "tabLabel": "CustomerSSN",
                "value": "12-345-6789"
            }]
        }
    }],
    "status": "sent"
}

但这并没有使用我提供的数据填充任何字段。

我在这里想念什么?

2 个答案:

答案 0 :(得分:1)

我最近遇到了这个问题,并得到了他们的支持团队。使用templateIdRecipients的文档基本上是错误的。它将永远失败。我认为他们很快就会改变。

{
    "accountId": "301424",
    "emailSubject": "API Example - Populating Data in Templates",
    "templateId": "44D9E888-xxxx-xxxx-xxxx-7071BC87A0DA",
    "templateRoles": [{
        "email": "john.doe@email.com",
        "name": "John Doe",
        "roleName": "Customer",
        "tabs": {
            "textTabs": [{
                "tabLabel": "CustomerAddress",
                "value": "123 Main St. San Francisco, CA 94105"
            }, 
            {
                "tabLabel": "CustomerSSN",
                "value": "12-345-6789"
            }]
        }
    }],
    "status": "sent"
}
  

我在UI上创建了一个模板,并上传了一个文档。然后,我添加了一个   从用户界面接收并在文档中映射了几个字段。

很明显,尽管UI在输入字段上显示一个红色星号,但这似乎是必需的,但您仍可以提供一个空白的收件人名称电子邮件

您只需要定义角色字段就可以了。因此,在此示例中,在您的模板中(通过用户界面):

enter image description here

您应该很好。

答案 1 :(得分:0)

您的JSON对我来说看起来不错。

您不需要accountIdemailSubject属性,建议您不要使用它们。

仔细检查您的tabLabel值是否与用户界面的数据标签设置完全相同。

作为测试,您也可以使用API​​下载模板。参见Templates::get

这是一个PHP code example,用于设置模板标签值。