Create Embedded Signature Request with Template
Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
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 you're using to create this embedded signature request. Used for security purposes.
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.
The 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 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 <= 255Controls whether auto fill fields can automatically populate a signer's information during signing.
NOTE: Keep your signer's information safe by ensuring that the signer on your signature request is the intended party before using this feature.
falseWhen 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/create_embedded_with_template" \ -H "Content-Type: application/json" \ -d '{ "client_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", "template_ids": [ "c26b8a16784a872da37ea946b9ddec7c1e11dff6" ], "subject": "Purchase Order", "message": "Glad we could come to an agreement.", "signers": [ { "role": "Client", "name": "George", "email_address": "george@example.com" } ], "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.", "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": null, "signing_redirect_url": null, "details_url": "https://app.hellosign.com/home/manage?guid=17d163069282df5eb63857d31ff4a3bffa9e46c0", "requester_email_address": "me@dropboxsign.com", "signatures": [ { "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3", "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" ] }}Create Embedded Signature Request POST
Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. 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. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
Edit Signature Request PUT
Edits and sends a 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. **NOTE:** Edit and resend *will* deduct your signature request quota.