Unclaimed Draft - Create Embedded With Template | HelloSign API Documentation
Unclaimed DraftA group of documents that a user can take ownership of via the claim URLA group of documents that a user can take ownership of via the claim URL
UnclaimedDraft Response Object.
signature_request_id The ID of the signature request that is represented by this UnclaimedDraft.
claim_url The URL to be used to claim this UnclaimedDraft.
signing_redirect_url The URL you want signers redirected to after they successfully sign.
requesting_redirect_url The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.).
expires_at When the link expires.
test_mode Whether this is a test draft. Signature requests made from test drafts have no legal value. Defaults to 0.
ACTION URI - Description
Create Embedded Unclaimed Draft with Template
POST /unclaimed_draft/create_embedded_with_template
Creates a new Draft using an existing template that will be claimed for use in an embedded iFrame.
Description

Creates a new Draft with a previously saved template 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 HelloSign.

Request Parameters
test_mode optional
Whether this is a test, the signature request created from this draft will not be legally binding if set to 1. Defaults to 0.
client_id
Client id of the app you're using to create this draft. Visit our embedded page to learn more about this parameter.
template_id or template_ids[%i%]
Use template_id to create a request from a single Template. Use template_ids[%i%] to create a request from multiple templates, where %i% is an integer indicating the order in which the template will be used. Only template_id or template_ids[%i%] can be used, not both.
requester_email_address
The email address of the user that should be designated as the requester of this draft, if the draft type is "request_signature."
title optional
The title you want to assign to the SignatureRequest.
subject optional
The subject in the email that will be sent to the signers.
message optional
The custom message in the email that will be sent to the signers.
signers[%RoleName%][name]
The name of the signer filling the role of RoleName. RoleName is case-sensitive.
signers[%RoleName%][email_address]
The email address of the signer filling the role of RoleName. RoleName is case-sensitive.
ccs[%RoleName%][email_address]
optional
The email address of the CC filling the role of RoleName. Required when a CC role exists for the Template. RoleName is case-sensitive.
signing_redirect_url optional
The URL you want the signer redirected to after they successfully sign.
requesting_redirect_url optional
The URL you want signers redirected to after they successfully request a signature.
is_for_embedded_signing optional
[boolean] The request created from this draft will also be signable in embedded mode if set to 1. Defaults to 0.
metadata[%key%] optional
Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys, with key names up to 40 characters long and values up to 1000 characters long.
custom_fields optional
A JSON array defining values for custom fields. Required when a custom field exists in the Template.
  • name: the name, or "Field Label," of the custom field (the field's API ID can be used here as well)
  • value: the value of the custom field
  • editor: the RoleName allowed to edit the custom field (optional, but required if 'required' is defined)
    Note: Editable custom_fields are only supported for single signer requests or the first signer of ordered signature requests. If more than one signer is assigned to the unordered signature request, any editor value is ignored and the field will not be editable.
  • required: a boolean describing if this field is required (default: false).
custom_fields[%CustomFieldName%] optional
DEPRECATED
The value that will be used to populate the Custom Field with the name of CustomFieldName. The CustomFieldName is the case-sensitive "Field Label" assigned to the field when creating the template. The field's API ID can be used here as well. If the custom field is a checkbox, the value "true" indicates that it is checked by default.
file[] or file_url[] optional
Append additional files to the signature request. HelloSign will parse the files for text tags. Text tags for signers not on the template will be ignored.

Use file[] to pass the uploaded file(s). Use file_url[] to have HelloSign download the file(s). We currently only support use of either the file[] parameter or file_url[] parameter, not both.
skip_me_now optional
Disables the "Me (Now)" option for the person preparing the document. Defaults to 0.
allow_decline optional
Allows signers to decline to sign a document if set to 1. Defaults to 0.
allow_reassign optional
Allows signers to reassign their signature requests to other signers if set to 1. Defaults to 0. Note: Only available for Gold plan and higher.
hold_request optional
The request from this draft will not automatically send to signers post-claim if set to 1. Requester must release the request from hold when ready to send. Defaults to 0.
signing_options optional
This allows the requester to specify the types allowed for creating a signature.
  • draw: [boolean] allows drawing the signature (default: false)
  • type: [boolean] allows typing the signature (default: false)
  • upload: [boolean] allows uploading the signature (default: false)
  • phone: [boolean] allows using a smartphone to email the signature (default: false)
  • default: the default type shown (limited to the above types) (required if signing_options defined)

If signing_options are not defined in the request, the allowed types will default to those specified in the account settings.
field_options optional
This allows the requester to specify field options for a signature request.
  • date_format: [string] allows requester to specify the date format (see list of allowed formats)
    Note: Only available for Platinum and higher.

editor_options optional
This allows the requester to specify editor options when a preparing a document.
  • allow_edit_signers: [boolean] allows requesters to edit the list of signers (default: false)
  • allow_edit_documents: [boolean] allows requesters to edit documents, including delete and add (default: false)

show_preview optional
This allows the requester to enable the editor/preview experience.
  • show_preview=1: [boolean] allows requesters to enable the editor/preview experience.
  • show_preview=0: [boolean] allows requesters to disable the editor/preview experience.

preview_only optional
This allows the requester to enable the preview experience experience.
  • preview_only=1: [boolean] allows requesters to enable the preview only experience.
  • preview_only=0: [boolean] allows requesters to disable the preview only experience.
Note: This parameter overwrites show_preview=1 (if set).
Response
Returns an UnclaimedDraft object
Example request / response
POST https://[api key]:@api.hellosign.com/v3/unclaimed_draft/create_embedded_with_template
client_id = b6b8e7deaf8f0b95c029dca049356d4a2cf9710a
template_id = 61a832ff0d8423f91d503e76bfbcc750f7417c78
requester_email_address = jack@hellosign.com
signers[Client][name] = George
signers[Client][email_address] = george@example.com
ccs[Accounting][email_address] = accounting@hellosign.com
custom_fields = [{"name":"Cost", "value":"$20,000"}]