OPENAPI / COMPONENTS / SCHEMAS

数据结构:Signature Request Bulk Send With Template Request

SignatureRequestBulkSendWithTemplateRequest

SignatureRequestBulkSendWithTemplateRequest 数据结构

object13字段
template_idsarray必填

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

signer_filestring

`signer_file` 是一个 CSV 文件,定义签名者字段的值和选项。必需的,除非使用 `signer_list`,否则不能同时使用两者。 CSV 可以包含以下列: - `name`:填写RoleName角色的签名者姓名 - `email_address`:填写RoleName角色的签名者的电子邮件地址 - `pin`:4 到 12 个字符的访问代码,用于保护此签名者的签名页(可选) - `sms_phone_number`:E.164 格式的电话号码,将通过短信接收代码以访问此签名者的签名页面。 (可选) 通过使用该功能,您同意您有责任获得签名者的同意,以接收来自 Dropbox Sign 的与此签名请求相关的短信,并确认您在为此签名请求启用短信传送之前已获得所有签名者的同意。 [了解更多](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on)。 **注意:** 在测试模式下不可用,需要标准计划或更高版本。 - `*_field`:任何带有 _field" 后缀的列都将被视为自定义字段(可选) 您只能在此处指定字段值,任何其他选项应在 custom_fields 请求参数中设置。 CSV 示例: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ```

signer_listSubBulkSignerList

`signer_list` 是一个定义签名者字段的值和选项的数组。必需的,除非使用 `signer_file`,否则不能同时使用两者。

allow_declineboolean

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

ccsSubCC

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

client_idstring

您想要与此请求关联的 API 应用程序的客户端 ID。用于应用为应用程序定义的品牌和回调 URL。

custom_fieldsSubCustomField

当与合并字段一起使用时,`custom_fields` 允许用户将预填充的数据添加到其签名请求中。 通过使用 `form_fields_per_document` 或 [文本标签](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) 添加合并字段,同时在一次 API 调用中将值与 `custom_fields` 一起传回,可以将预填充数据与“发送一次”签名请求一起使用。 为了在可重复的签名请求上使用预填充,合并字段将添加到 Dropbox Sign UI 中的模板中,或者通过调用 [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft),然后在引用该模板的后续签名请求上传递 `custom_fields`。

messagestring

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

metadataobject

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

signing_redirect_urlstring

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

subjectstring

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

test_modeboolean

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

titlestring

您要分配给 SignatureRequest 的标题。