OPENAPI / COMPONENTS / SCHEMAS

数据结构:Signature Request Edit With Template Request

SignatureRequestEditWithTemplateRequest

根据 template_ids 参数指定的模板编辑并发送 SignatureRequest。 **注意:** 编辑并重新发送*将*扣除您的签名请求配额。

object16字段
template_idsarray必填

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

allow_declineboolean

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

ccsSubCC

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

client_idstring

与签名请求关联的应用程序的客户端 ID。用于应用为应用程序定义的品牌和回调 URL。

custom_fieldsSubCustomField

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

filesarray

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

file_urlsarray

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

is_eidboolean

如果您希望启用,请发送 `true` 值 [电子身份识别(eID)](https://sign.dropbox.com/features/electronic-id), 这要求签名者向 eID 提供商验证其身份才能签署文档。<br> **注意:** 您需要 eID 插件才能使用此功能。请[联系销售人员](https://sign.dropbox.com/form/contact-sales)了解更多信息。不能用于`test_mode`。仅适用于只有一位签名者的请求。

messagestring

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

metadataobject

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

signersSubSignatureRequestTemplateSigner必填

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

signing_optionsSubSigningOptions

signing_redirect_urlstring

您希望签名者在成功签名后重定向到的 URL。

subjectstring

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

test_modeboolean

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

titlestring

您要分配给 SignatureRequest 的标题。