OPENAPI / COMPONENTS / SCHEMAS
数据结构:Sub Custom Field
SubCustomField当与合并字段一起使用时,`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`。
editorstring用于创建可编辑的合并字段。当该值与通过 `signers` 传入的角色匹配时,该角色可以编辑预填充到该字段的数据。此字段是可选的,但当此自定义字段对象设置为 `required = true` 时,该字段是必需的。 **注意:** 仅单个签名者请求(或有序签名请求中的第一个签名者)支持可编辑合并字段。如果在无序签名请求中有多个签名者时使用,则编辑器值将被忽略,并且该字段将不可编辑。
namestring必填自定义字段的名称。使用预填充数据时,自定义字段的名称必须具有匹配的合并字段名称,否则该字段在签名期间将在文档上保持为空。
requiredboolean用于在处理预填充数据时设置可编辑合并字段。当 `true` 时,自定义字段必须指定 `editor` 中的签名者角色。
valuestring解析(也称为“预填充”)到用于签名的最终文档上的合并字段的字符串。