Send with Template
Creates and sends a new SignatureRequest based off of the Template(s) specified with the template_ids parameter.
Your API key can be used to make calls to the Dropbox Sign API. See Authentication for more information.
ā
Supported by Try it console (calls sent in test_mode only).
In: header
Use template_ids to create a SignatureRequest from one or more templates, in the order in which the template will be used.
Allows signers to decline to sign a document if true. Defaults to false.
falseAdd CC email recipients. Required when a CC role exists for the Template.
Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.
An array defining values and options for custom fields. Required when a custom field exists in the Template.
Use files[] to indicate the uploaded file(s) to send for signature.
This endpoint requires either files or file_urls[], but not both.
Use file_urls[] to have Dropbox Sign download the file(s) to send for signature.
This endpoint requires either files or file_urls[], but not both.
Send with a value of true if you wish to enable
electronic identification (eID),
which requires the signer to verify their identity with an eID provider to sign a document.
NOTE: You need the eID add-on to use this feature. Please contact sales for more information. Cannot be used in test_mode. Only works on requests with one signer.
falseThe custom message in the email that will be sent to the signers.
length <= 5000Key-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.
items <= 10Add Signers to your Templated-based Signature Request.
This allows the requester to specify the types allowed for creating a signature and specify another signing options.
NOTE: If signing_options are not defined in the request, the allowed types will default to those specified in the account settings.
NOTE: If force_advanced_signature_details is set, allowed types has to be defined too.
The URL you want signers redirected to after they successfully sign.
The subject in the email that will be sent to the signers.
length <= 255Whether this is a test, the signature request will not be legally binding if set to true. Defaults to false.
falseThe title you want to assign to the SignatureRequest.
length <= 255When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See Signature Request Expiration Date for details.
Response Body
application/json
application/json
curl -X POST "https://example.com/signature_request/send_with_template" \ -H "Content-Type: application/json" \ -d '{ "template_ids": [ "61a832ff0d8423f91d503e76bfbcc750f7417c78" ], "subject": "Purchase Order", "message": "Glad we could come to an agreement.", "signers": [ { "role": "Client", "name": "George", "email_address": "george@example.com" } ], "ccs": [ { "role": "Accounting", "email_address": "accounting@example.com" } ], "custom_fields": [ { "name": "Cost", "value": "$20,000", "editor": "Client", "required": true } ], "signing_options": { "draw": true, "type": true, "upload": true, "phone": false, "default_type": "draw", "force_advanced_signature_details": false }, "test_mode": true }'{ "signature_request": { "signature_request_id": "17d163069282df5eb63857d31ff4a3bffa9e46c0", "title": "Purchase Order", "original_title": "Purchase Order", "subject": "Purchase Order", "metadata": {}, "message": "Glad we could come to an agreement.", "created_at": 1570471067, "is_complete": false, "is_declined": false, "has_error": false, "custom_fields": [ { "name": "Cost", "value": "$20,000", "type": "text", "editor": "Client", "required": true } ], "response_data": [], "signing_url": "https://app.hellosign.com/sign/17d163069282df5eb63857d31ff4a3bffa9e46c0", "signing_redirect_url": null, "details_url": "https://app.hellosign.com/home/manage?guid=17d163069282df5eb63857d31ff4a3bffa9e46c0", "requester_email_address": "me@dropboxsign.com", "signatures": [ { "signature_id": "10ab1cd037d9b6cba7975d61ff428c8d", "signer_email_address": "george@example.com", "signer_name": "George", "signer_role": "Client", "order": null, "status_code": "awaiting_signature", "signed_at": null, "last_viewed_at": null, "last_reminded_at": null, "has_pin": false, "has_sms_auth": false } ], "cc_email_addresses": [ "accounting@dropboxsign.com" ] }}Send Signature Request POST
Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
Update Signature Request POST
Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page.