创建模板

创建可在将来的签名请求中使用的模板。如果提供了 `client_id`，则模板将被创建为嵌入模板。嵌入式模板可用于嵌入式签名请求，并且可以稍后通过使用 [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/) 生成新的 `edit_url` 进行编辑。接受初始请求后，模板创建可能会异步完成。建议实现回调来监听回调事件。 `template_created` 事件表示模板已准备好使用，而 `template_error` 事件表示创建模板时出现问题。如果已配置回调处理程序，但在调用后 60 分钟内未收到事件，请在 API 仪表板中检查请求的状态，并在必要时重试该请求。

通过完整的 Dropbox Sign v3 API 管理账户、签名请求、模板、团队、批量发送、文件下载、传真和事件回调；Hub 仅提供文档与本地 SDK/CLI。

请求

operationId: templateCreate
服务器: https://api.hellosign.com/v3
认证: api_key, oauth2

请求参数

无 URL、查询或 Header 参数。

Body 参数

TemplateCreateRequest必填

Content-Type: application/json, multipart/form-data

字段: filesfile_urlsallow_reassignattachmentscc_rolesclient_idfield_optionsform_field_groupsform_field_rulesform_fields_per_documentmerge_fieldsmessagemetadatasigner_rolessubjecttest_modetitleuse_preexisting_fields

{
  "files": [
    {}
  ],
  "file_urls": [
    "https://example.com/resource"
  ],
  "allow_reassign": false,
  "attachments": [
    {
      "name": "Example Name",
      "required": false,
      "signer_index": 0
    }
  ],
  "cc_roles": [
    {}
  ],
  "client_id": "example-client-id",
  "field_options": {
    "date_format": "MM / DD / YYYY"
  },
  "form_field_groups": [
    {
      "group_id": "example-group-id"
    }
  ]
}

响应

`200`

TemplateCreateResponseapplication/json

成功响应

字段: templatewarnings

`4XX`

ErrorResponseapplication/json

操作失败

字段: error

{
  "template": {
    "template_id": "example-template-id"
  },
  "warnings": [
    {
      "warning_name": "Example Name"
    }
  ]
}