文档签名:如何在创建信封时发送文档自定义字段(又名选项卡定义)的值?



我需要一些帮助来确定如何在创建信封的阶段发送文档自定义字段的值。以下是工作流程:

  1. 通过 API 创建具有名称、类型和初始值的文档自定义字段(特定于帐户((POST [BaseURI]/tab_definitions(
  2. 通过API创建包含文档的模板,并通过DocuSign UI将所需的文档自定义字段放置在文档中
  3. 创建一个信封,并通过 API 为文档自定义字段发送特定值(POST [BaseURI]/信封(

创建信封可以正常工作 (https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create(。我尝试通过以下方式发送值:

  • 文档 -> 文档字段
  • 自定义字段 -> 文本自定义字段
{
"templateId": "51234567-1244-1234-1234-12345a857203",
"templateRoles": [
{
"roleName": "Role1",
"name": "Jane Doe",
"email": "jane@doe.com"
},
{
"roleName": "Role2",
"name": "John Doe",
"email": "john@doe.com"
}
],
"customFields": {
"textCustomFields": [
{
"name": "Account.Name",
"value": "account-name1234"
},
{
"name": "Candidate.FullName",
"value": "candidate-name1234"
},
{
"name": "Candidate.Mobile",
"value": "0412345678"
}
]
},
"status": "sent"
}

自定义字段参数适用于信封自定义字段。如果要为收件人定义标记值,标记参数应嵌套在模板角色下。您还需要使用tabLabel参数来标识选项卡,而不是name。最后,确保您的角色名称和选项卡标签在模板和 API 调用之间完全匹配。试试这个:

{
"templateId": "51234567-1244-1234-1234-12345a857203",
"templateRoles": [
{
"roleName": "Role1",
"name": "Jane Doe",
"email": "jane@doe.com"
"tabs": {
"TextTabs": [
{
"tabLabel": "Account.Number",
"value": "00000000"
},
{
"tabLabel": "Account.Name",
"value":"ExampleAccount"
}
],
},
{
"roleName": "Role2",
"name": "John Doe",
"email": "john@doe.com"
}
],
"status": "sent"
}

最后,您可能需要考虑使用复合模板,而不是基本的信封创建调用。有关原因的详细信息,请点击此处:https://www.docusign.com/blog/dsdev-why-use-composite-templates/

最新更新