Whether this is a test, the signature request created from this draft will not be legally binding if set to 1. Defaults to 0.
Allows signers to decline to sign a document if set to 1. Defaults to 0.
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.
The email address of the user that should be designated as the requester of this draft, if the draft type is "request_signature."
The title you want to assign to the SignatureRequest.
The subject in the email that will be sent to the signers.
The custom message in the email that will be sent to the signers.
The name of the signer filling the role of RoleName.
The email address of the signer filling the role of RoleName.
The email address of the CC filling the role of RoleName. Required when a CC role exists for the Template.
The URL you want the signer redirected to after they successfully sign.
The URL you want signers redirected to after they successfully request a signature.
[boolean] The request created from this draft will also be signable in embedded mode if set to 1. Defaults to 0.
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.
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
The value that will be used to populate the Custom Field with the name of CustomFieldName. The CustomFieldName is the "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.
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.