Create Embedded Unclaimed Draft with Template

Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed 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: unclaimedDraftCreateEmbeddedWithTemplate
Server: https://api.hellosign.com/v3
Authentication: api_key, oauth2

Request parameters

No URL, query, or header parameters.

Request body

UnclaimedDraftCreateEmbeddedWithTemplateRequestrequired

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

Properties: allow_declineallow_reassignccsclient_idcustom_fieldseditor_optionsfield_optionsfilesfile_urlsforce_signer_rolesforce_subject_messagehold_requestis_for_embedded_signingmessagemetadatapreview_onlyrequester_email_addressrequesting_redirect_urlshow_previewshow_progress_steppersignerssigning_optionssigning_redirect_urlskip_me_nowsubjecttemplate_idstest_modetitlepopulate_auto_fill_fieldsallow_ccs

{
  "allow_decline": false,
  "allow_reassign": false,
  "ccs": [
    {
      "email_address": "developer@example.com"
    }
  ],
  "client_id": "example-client-id",
  "custom_fields": [
    {
      "name": "Example Name",
      "required": false
    }
  ],
  "editor_options": {
    "allow_edit_signers": false,
    "allow_edit_documents": false
  },
  "field_options": {
    "date_format": "MM / DD / YYYY"
  },
  "files": [
    {}
  ]
}

Responses

`200`

UnclaimedDraftCreateResponseapplication/json

successful operation

Properties: unclaimed_draftwarnings

`4XX`

ErrorResponseapplication/json

failed_operation

Properties: error

{
  "unclaimed_draft": {
    "signature_request_id": "example-signature-request-id",
    "claim_url": "https://example.com/resource",
    "signing_redirect_url": "https://example.com/resource",
    "requesting_redirect_url": "https://example.com/resource",
    "expires_at": 0,
    "test_mode": false
  },
  "warnings": [
    {
      "warning_name": "Example Name"
    }
  ]
}