Send with Template

post/signature_request/send_with_template

Creates and sends a new SignatureRequest based off of the Template(s) specified with the template_ids parameter.

Securityapi_key or oauth2
Request
Request Body schema:
required
Array of objects (SubSignatureRequestTemplateSigner)

Add Signers to your Templated-based Signature Request.

template_ids
required
Array of strings

Use template_ids to create a SignatureRequest from one or more templates, in the order in which the template will be used.

allow_decline
boolean
Default: false

Allows signers to decline to sign a document if true. Defaults to false.

Array of objects (SubCC)

Add CC email recipients. Required when a CC role exists for the Template.

client_id
string

Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.

Array of objects (SubCustomField)

An array defining values and options for custom fields. Required when a custom field exists in the Template.

file
Array of strings <binary>

Use file[] to indicate the uploaded file(s) to send for signature.

This endpoint requires either file or file_url[], but not both.

file_url
Array of strings

Use file_url[] to have HelloSign download the file(s) to send for signature.

This endpoint requires either file or file_url[], but not both.

is_qualified_signature
boolean
Default: false

Send with a value of true if you wish to enable Qualified Electronic Signatures (QES), which requires a face-to-face call to verify the signer's identity.
Note: QES is only available on the Premium API plan as an add-on purchase. Cannot be used in test_mode. Only works on requests with one signer.

message
string <= 5000 characters

The custom message in the email that will be sent to the signers.

object <= 10 items

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 (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.

object (SubSigningOptions)

This allows the requester to specify the types allowed for creating a signature.

Note: If signing_options are not defined in the request, the allowed types will default to those specified in the account settings.

signing_redirect_url
string

The URL you want signers redirected to after they successfully sign.

subject
string <= 255 characters

The subject in the email that will be sent to the signers.

test_mode
boolean
Default: false

Whether this is a test, the signature request will not be legally binding if set to true. Defaults to false.

title
string <= 255 characters

The title you want to assign to the SignatureRequest.

Responses
200

successful operation

4XX

failed_operation

Request samples
{
  • "template_ids": [
    ],
  • "subject": "Purchase Order",
  • "message": "Glad we could come to an agreement.",
  • "signers": [
    ],
  • "ccs": [
    ],
  • "custom_fields": [
    ],
  • "signing_options": {
    },
  • "test_mode": true
}
Response samples
application/json
{
  • "signature_request": {
    }
}