使用模板创建嵌入式签名请求

根据要在嵌入式 iFrame 中签名的给定模板创建新的 SignatureRequest。请注意，嵌入式签名请求只能在嵌入式 iFrame 中签名，而普通签名请求只能在 Dropbox Sign 上签名。

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

请求

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

请求参数

无 URL、查询或 Header 参数。

Body 参数

SignatureRequestCreateEmbeddedWithTemplateRequest必填

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

字段: template_idsallow_declineccsclient_idcustom_fieldsfilesfile_urlsmessagemetadatasignerssigning_optionssubjecttest_modetitlepopulate_auto_fill_fields

{
  "template_ids": [
    {}
  ],
  "allow_decline": false,
  "ccs": [
    {
      "email_address": "developer@example.com"
    }
  ],
  "client_id": "example-client-id",
  "custom_fields": [
    {
      "name": "Example Name",
      "required": false
    }
  ],
  "files": [
    {}
  ],
  "file_urls": [
    "https://example.com/resource"
  ],
  "message": "Example message"
}

响应

`200`

SignatureRequestGetResponseapplication/json

成功响应

字段: signature_requestwarnings

`4XX`

ErrorResponseapplication/json

操作失败

字段: error

{
  "signature_request": {
    "test_mode": false,
    "signature_request_id": "example-signature-request-id",
    "requester_email_address": "developer@example.com",
    "title": "Example document",
    "original_title": "Example document",
    "subject": "Example document",
    "message": "Example message",
    "metadata": {}
  },
  "warnings": [
    {
      "warning_name": "Example Name"
    }
  ]
}