OPENAPI / COMPONENTS / SCHEMAS

数据结构:Unclaimed Draft Create Embedded With Template Request

UnclaimedDraftCreateEmbeddedWithTemplateRequest

UnclaimedDraftCreateEmbeddedWithTemplateRequest 数据结构

object30字段
allow_declineboolean

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

allow_reassignboolean

如果设置为 `true`,则允许签名者将其签名请求重新分配给其他签名者。默认为 `false`。 **注意:** 仅适用于高级计划及更高版本。

ccsSubCC

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

client_idstring必填

用于创建草稿的应用程序的客户端 ID。用于应用为应用程序定义的品牌和回调 URL。

custom_fieldsSubCustomField

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

editor_optionsSubEditorOptions

field_optionsSubFieldOptions

filesarray

使用 `files[]` 将其他文件附加到从模板创建的签名请求中。 Dropbox Sign将解析文件中的[文本标签](https://app.hellosign.com/api/textTagsWalkthrough)并将其附加到签名请求中。不在模板上的签名者的文本标签将被忽略。 **files** 或 **file_urls[]** 是必需的,但不是两者都需要。

file_urlsarray

使用 file_urls[] 将其他文件附加到从模板创建的签名请求中。 Dropbox Sign 将下载该文件,然后解析它的[文本标签](https://app.hellosign.com/api/textTagsWalkthrough),并附加到签名请求中。不在模板上的签名者的文本标签将被忽略。 **files** 或 **file_urls[]** 是必需的,但不是两者都需要。

force_signer_rolesboolean

为用户提供查看/编辑模板签名者角色的能力。

force_subject_messageboolean

为用户提供查看/编辑模板主题和消息的能力。

hold_requestboolean

如果设置为 1,此草稿中的请求不会在声明后自动发送给签名者。请求者必须在准备发送时[释放](/api/reference/operation/signatureRequestReleaseHold/) 保留的请求。默认为 `false`。

is_for_embedded_signingboolean

如果设置为 `true`,从此草案创建的请求也可以在嵌入模式下进行签名。默认为 `false`。

messagestring

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

metadataobject

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

preview_onlyboolean

这允许请求者启用预览体验(即不允许请求者的最终用户通过编辑器添加任何其他字段)。 - `preview_only=true`:允许请求者启用仅预览体验。 - `preview_only=false`:允许请求者禁用仅预览体验。 **注意:** 此参数将覆盖 `show_preview=1`(如果设置)。

requester_email_addressstring必填

应指定为本草稿请求者的用户的电子邮件地址。

requesting_redirect_urlstring

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

show_previewboolean

这允许请求者启用编辑器/预览体验。 - `show_preview=true`:允许请求者启用编辑器/预览体验。 - `show_preview=false`:允许请求者禁用编辑器/预览体验。

show_progress_stepperboolean

当签名请求过程中只剩下一步骤并且该参数设置为 `false` 时,进度步进器将被隐藏。

signersSubUnclaimedDraftTemplateSigner

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

signing_optionsSubSigningOptions

signing_redirect_urlstring

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

skip_me_nowboolean

为准备文档的人员禁用“我(现在)”选项。不适用于 `send_document` 类型。默认为 `false`。

subjectstring

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

template_idsarray必填

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

test_modeboolean

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

titlestring

您要分配给 SignatureRequest 的标题。

populate_auto_fill_fieldsboolean

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

allow_ccsboolean

这允许请求者指定是否允许用户在领取草稿时向 CC 提供电子邮件地址。