OPENAPI / COMPONENTS / SCHEMAS
数据结构:Unclaimed Draft Create Embedded Request
UnclaimedDraftCreateEmbeddedRequest创建可以在嵌入式 iFrame 中声明和使用的新草稿。第一个访问该 URL 的经过身份验证的用户将声明该草稿,并将显示加载了草稿的“请求签名”页面。后续访问声明 URL 将导致 `404`。对于此嵌入式 Endpoint,需要 `requester_email_address` 参数。 **注意:** 嵌入式无人认领草稿只能在嵌入式 iFrame 中访问,而普通草稿可以在 Dropbox Sign 上使用和访问。
filesarray使用 `files[]` 指示要发送以供签名的上传文件。 此 Endpoint 需要 **files** 或 **file_urls[]**,但不能同时使用两者。
file_urlsarray使用 `file_urls[]` 让 Dropbox Sign 下载文件以发送签名。 此 Endpoint 需要 **files** 或 **file_urls[]**,但不能同时使用两者。
allow_ccsboolean这允许请求者指定是否允许用户在领取草稿时向 CC 提供电子邮件地址。
allow_declineboolean如果 `true`,则允许签名者拒绝签署文档。默认为 `false`。
allow_reassignboolean如果设置为 `true`,则允许签名者将其签名请求重新分配给其他签名者。默认为 `false`。 **注意:** 仅适用于高级计划及更高版本。
attachmentsSubAttachment描述附件的列表
cc_email_addressesarray应抄送的电子邮件地址。
client_idstring必填用于创建草稿的应用程序的客户端 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`。
editor_optionsSubEditorOptionsfield_optionsSubFieldOptionsforce_signer_pageboolean为用户提供查看/编辑签名者的能力。
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`
hide_text_tagsboolean如果您希望启用自动文本标签删除,请发送值 `true`。默认为 `false`。使用文本标签时,最好将其设置为 `false` 并用白色文本或类似内容隐藏标签,因为自动删除系统可能会导致不必要的剪切。有关更多详细信息,请参阅[文本标签](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro)演练。
hold_requestboolean如果设置为 `true`,则此草稿中的请求不会在声明后自动发送给签名者。准备发送时,请求者必须[释放](/api/reference/operation/signatureRequestReleaseHold/) 保留的请求。默认为 `false`。
is_for_embedded_signingboolean如果设置为 `true`,从此草案创建的请求也可以在嵌入模式下进行签名。默认为 `false`。
messagestring将发送给签名者的电子邮件中的自定义消息。
metadataobject应附加到签名请求的键值数据。此元数据包含在涉及签名请求的所有 API 响应和事件中。例如,使用元数据字段来存储签名者的订单号,以便在接收签名请求的事件时进行查找。 每个请求最多可包含 10 个元数据键(或 50 个嵌套元数据键),键名称最长可达 40 个字符,值最长可达 1000 个字符。
requester_email_addressstring必填如果草稿类型为 `request_signature`,则应指定为此草稿请求者的用户的电子邮件地址。
requesting_redirect_urlstring您希望签名者在成功请求签名后重定向到的 URL。
show_previewboolean这允许请求者启用编辑器/预览体验。 - `show_preview=true`:允许请求者启用编辑器/预览体验。 - `show_preview=false`:允许请求者禁用编辑器/预览体验。
show_progress_stepperboolean当签名请求过程中只剩下一步骤并且该参数设置为 `false` 时,进度步进器将被隐藏。
signersSubUnclaimedDraftSigner将签名者添加到无人认领的草稿签名请求中。
signing_optionsSubSigningOptionssigning_redirect_urlstring您希望签名者在成功签名后重定向到的 URL。
skip_me_nowboolean为准备文档的人员禁用“我(现在)”选项。不适用于 `send_document` 类型。默认为 `false`。
subjectstring将发送给签名者的电子邮件中的主题。
test_modeboolean无论这是一个测试,如果设置为`true`,根据该草案创建的签名请求将不具有法律约束力。默认为 `false`。
typestring草稿的类型。默认情况下,这是 `request_signature`,但如果您想自签名文档并下载它,可以将其设置为 `send_document`。
use_preexisting_fieldsboolean将 `use_text_tags` 设置为 `true` 以在文档中启用[文本标签](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) 解析(默认为禁用,或 `false`)。或者,如果您的 PDF 包含预定义字段,请通过将 `use_preexisting_fields` 设置为 `true`(默认为禁用,或 `false`)来启用对这些字段的检测。目前我们仅支持使用 `use_text_tags` 或 `use_preexisting_fields` 参数,而不支持同时使用两者。
use_text_tagsboolean将 `use_text_tags` 设置为 `true` 以在文档中启用[文本标签](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) 解析(默认为禁用,或 `false`)。或者,如果您的 PDF 包含预定义字段,请通过将 `use_preexisting_fields` 设置为 `true`(默认为禁用,或 `false`)来启用对这些字段的检测。目前我们仅支持使用 `use_text_tags` 或 `use_preexisting_fields` 参数,而不支持同时使用两者。
populate_auto_fill_fieldsboolean控制[自动填充字段](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields)是否可以在签名期间自动填充签名者的信息。 **注意:** 在使用此功能之前,请确保签名请求中的_签名者是预期方_,以确保签名者信息的安全。
expires_atinteger签名请求何时到期。未签名的签名将转为过期状态,并且不再可签名。详情请参阅[签名请求到期日期](https://developers.hellosign.com/docs/signature-request/expiration/)。 **注意:** 这与响应中返回的 **expires_at** 不对应。