OPENAPI / COMPONENTS / SCHEMAS

数据结构:Signature Request Create Embedded With Template Request

SignatureRequestCreateEmbeddedWithTemplateRequest

SignatureRequestCreateEmbeddedWithTemplateRequest 数据结构

object15字段
template_idsarray必填

使用 `template_ids` 从一个或多个模板创建 SignatureRequest,按照模板的使用顺序。

allow_declineboolean

如果 `true`,则允许签名者拒绝签署文档。默认为 `false`。

ccsSubCC

添加抄送电子邮件收件人。当模板存在 CC 角色时需要。

client_idstring必填

您用来创建此嵌入式签名请求的应用程序的客户端 ID。用于安全目的。

custom_fieldsSubCustomField

定义自定义字段的值和选项的数组。当模板中存在自定义字段时必需。

filesarray

使用 `files[]` 指示要发送以供签名的上传文件。 此 Endpoint 需要 **files** 或 **file_urls[]**,但不能同时使用两者。

file_urlsarray

使用 `file_urls[]` 让 Dropbox Sign 下载文件以发送签名。 此 Endpoint 需要 **files** 或 **file_urls[]**,但不能同时使用两者。

messagestring

将发送给签名者的电子邮件中的自定义消息。

metadataobject

应附加到签名请求的键值数据。此元数据包含在涉及签名请求的所有 API 响应和事件中。例如,使用元数据字段来存储签名者的订单号,以便在接收签名请求的事件时进行查找。 每个请求最多可包含 10 个元数据键(或 50 个嵌套元数据键),键名称最长可达 40 个字符,值最长可达 1000 个字符。

signersSubSignatureRequestTemplateSigner必填

将签名者添加到基于模板的签名请求中。

signing_optionsSubSigningOptions

subjectstring

将发送给签名者的电子邮件中的主题。

test_modeboolean

无论这是一个测试,如果设置为`true`,签名请求将不具有法律约束力。默认为 `false`。

titlestring

您要分配给 SignatureRequest 的标题。

populate_auto_fill_fieldsboolean

控制[自动填充字段](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields)是否可以在签名期间自动填充签名者的信息。 **注意:** 在使用此功能之前,请确保签名请求中的_签名者是预期方_,以确保签名者信息的安全。