OPENAPI / COMPONENTS / SCHEMAS

数据结构:Template Create Embedded Draft Request

TemplateCreateEmbeddedDraftRequest

TemplateCreateEmbeddedDraftRequest 数据结构

object25字段
filesarray

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

file_urlsarray

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

allow_ccsboolean

这允许请求者指定在创建模板时是否允许用户向 CC 提供电子邮件地址。

allow_reassignboolean

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

attachmentsSubAttachment

描述附件的列表

cc_rolesarray

使用模板发送签名请求时必须分配的CC角色

client_idstring必填

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

editor_optionsSubEditorOptions

field_optionsSubFieldOptions

force_signer_rolesboolean

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

force_subject_messageboolean

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

form_field_groupsSubFormFieldGroup

`form_fields_per_document` 中定义的字段的组信息。带有 `group_label` 和 `requirement` 键的字符串索引 JSON 数组。 `form_fields_per_document` 必须包含引用 `form_field_groups` 中定义的组的字段。

form_field_rulesSubFormFieldRule

`form_fields_per_document` 中定义的字段的条件逻辑规则。

form_fields_per_documentSubFormFieldsPerDocumentBase

应出现在文档中的字段,表示为对象数组。 (有关更多详细信息,您可以在这里阅读:[使用每个文档的表单字段](/docs/openapi/form-fields-per-document)。) **注意:** 像 **text**、**dropdown**、**checkbox**、**radio** 和 **hyperlink** 等字段具有额外的必填和可选参数。查看这些字段类型的[附加参数](/api/reference/constants/#form-fields-per-document)列表。 * 文本字段使用`SubFormFieldsPerDocumentText` * 下拉字段使用`SubFormFieldsPerDocumentDropdown` * 超链接字段使用`SubFormFieldsPerDocumentHyperlink` * 复选框字段使用 `SubFormFieldsPerDocumentCheckbox` * 无线电现场使用`SubFormFieldsPerDocumentRadio` * 签名字段使用`SubFormFieldsPerDocumentSignature` * 签名日期 字段使用 `SubFormFieldsPerDocumentDateSigned` * 缩写 现场使用 `SubFormFieldsPerDocumentInitials` * 文本合并字段使用`SubFormFieldsPerDocumentTextMerge` * 复选框合并字段使用 `SubFormFieldsPerDocumentCheckboxMerge`

merge_fieldsSubMergeField

将合并字段添加到模板中。合并字段由创建模板的用户放置,并通过使用 `custom_fields` 参数将值传递到签名请求来预填充数据。 如果使用该模板的签名请求“不”将值传递到合并字段中,则文档中将保留一个空字段。

messagestring

默认模板电子邮件。

metadataobject

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

show_previewboolean

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

show_progress_stepperboolean

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

signer_rolesSubTemplateRole

使用此模板发送 SignatureRequest 时必须指定的指定签名者角色的数组。

skip_me_nowboolean

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

subjectstring

模板标题(别名)。

test_modeboolean

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

titlestring

您要分配给 SignatureRequest 的标题。

use_preexisting_fieldsboolean

通过将 `use_preexisting_fields` 设置为 `true`(默认为禁用,或 `false`)来启用预定义 PDF 字段的检测。