Create Embedded Signature Request with Template

Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.

Manage accounts, signature requests, templates, teams, bulk sends, file downloads, fax, and event callbacks through the complete Dropbox Sign v3 API; the Hub provides documentation and a local SDK/CLI only.

Request

operationId: signatureRequestCreateEmbeddedWithTemplate
Server: https://api.hellosign.com/v3
Authentication: api_key, oauth2

Request parameters

No URL, query, or header parameters.

Request body

SignatureRequestCreateEmbeddedWithTemplateRequestrequired

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

Properties: 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"
}

Responses

`200`

SignatureRequestGetResponseapplication/json

successful operation

Properties: signature_requestwarnings

`4XX`

ErrorResponseapplication/json

failed_operation

Properties: 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"
    }
  ]
}