Skip to main content
Server path: /dropbox-sign-signatures | Type: Application | PCID required: Yes

​
Tools

ToolDescription
dropbox_sign_signatures_bulk_send_job_getGet Bulk Send Job
dropbox_sign_signatures_bulk_send_job_listList Bulk Send Jobs
dropbox_sign_signatures_embedded_edit_urlGet Embedded Template Edit URL
dropbox_sign_signatures_embedded_sign_urlGet Embedded Sign URL
dropbox_sign_signatures_signature_request_bulk_create_embedded_with_templateEmbedded Bulk Send with Template
dropbox_sign_signatures_signature_request_bulk_send_with_templateBulk Send with Template
dropbox_sign_signatures_signature_request_cancelCancel Incomplete Signature Request
dropbox_sign_signatures_signature_request_create_embeddedCreate Embedded Signature Request
dropbox_sign_signatures_signature_request_create_embedded_with_templateCreate Embedded Signature Request with Template
dropbox_sign_signatures_signature_request_editEdit Signature Request
dropbox_sign_signatures_signature_request_edit_embeddedEdit Embedded Signature Request
dropbox_sign_signatures_signature_request_edit_embedded_with_templateEdit Embedded Signature Request with Template
dropbox_sign_signatures_signature_request_edit_with_templateEdit Signature Request With Template
dropbox_sign_signatures_signature_request_filesDownload Files
dropbox_sign_signatures_signature_request_files_as_data_uriDownload Files as Data Uri
dropbox_sign_signatures_signature_request_files_as_file_urlDownload Files as File Url
dropbox_sign_signatures_signature_request_getGet Signature Request
dropbox_sign_signatures_signature_request_listList Signature Requests
dropbox_sign_signatures_signature_request_release_holdRelease On-Hold Signature Request
dropbox_sign_signatures_signature_request_remindSend Request Reminder
dropbox_sign_signatures_signature_request_removeRemove Signature Request Access
dropbox_sign_signatures_signature_request_sendSend Signature Request
dropbox_sign_signatures_signature_request_send_with_templateSend with Template
dropbox_sign_signatures_signature_request_updateUpdate Signature Request
dropbox_sign_signatures_template_add_userAdd User to Template
dropbox_sign_signatures_template_createCreate Template
dropbox_sign_signatures_template_create_embedded_draftCreate Embedded Template Draft
dropbox_sign_signatures_template_deleteDelete Template
dropbox_sign_signatures_template_filesGet Template Files
dropbox_sign_signatures_template_files_as_data_uriGet Template Files as Data Uri
dropbox_sign_signatures_template_files_as_file_urlGet Template Files as File Url
dropbox_sign_signatures_template_getGet Template
dropbox_sign_signatures_template_listList Templates
dropbox_sign_signatures_template_remove_userRemove User from Template
dropbox_sign_signatures_template_update_filesUpdate Template Files
dropbox_sign_signatures_unclaimed_draft_createCreate Unclaimed Draft
dropbox_sign_signatures_unclaimed_draft_create_embeddedCreate Embedded Unclaimed Draft
dropbox_sign_signatures_unclaimed_draft_create_embedded_with_templateCreate Embedded Unclaimed Draft with Template
dropbox_sign_signatures_unclaimed_draft_edit_and_resendEdit and Resend Unclaimed Draft

​
dropbox_sign_signatures_bulk_send_job_get

Get Bulk Send Job Parameters:
ParameterTypeRequiredDefaultDescription
bulk_send_job_idstringYes—The id of the BulkSendJob to retrieve.
pageintegerNo—Which page number of the BulkSendJob list to return. Defaults to 1.
page_sizeintegerNo—Number of objects to be returned per page. Must be between 1 and 100. Default is 20.

​
dropbox_sign_signatures_bulk_send_job_list

List Bulk Send Jobs Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNo—Which page number of the BulkSendJob List to return. Defaults to 1.
page_sizeintegerNo—Number of objects to be returned per page. Must be between 1 and 100. Default is 20.

​
dropbox_sign_signatures_embedded_edit_url

Get Embedded Template Edit URL Parameters:
ParameterTypeRequiredDefaultDescription
template_idstringYes—The id of the template to edit.
allow_edit_ccsbooleanNo—This allows the requester to enable/disable to add or change CC roles when editing the template.
cc_rolesstring[]No—The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.
editor_optionsobjectNo—This allows the requester to specify editor options when a preparing a document
force_signer_rolesbooleanNo—Provide users the ability to review/edit the template signer roles.
force_subject_messagebooleanNo—Provide users the ability to review/edit the template subject and message.
merge_fieldsobject[]No—Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template. Remove all merge fields on the template by passing an empty array [].
preview_onlybooleanNo—This allows the requester to enable the preview experience (i.e. does not allow the requester’s end user to add any additional fields via the editor). NOTE: This parameter overwrites show_preview=true (if set).
show_previewbooleanNo—This allows the requester to enable the editor/preview experience.
show_progress_stepperbooleanNo—When only one step remains in the signature request process and this parameter is set to false then the progress stepper will be hidden.
test_modebooleanNo—Whether this is a test, locked templates will only be available for editing if this is set to true. Defaults to false.

​
dropbox_sign_signatures_embedded_sign_url

Get Embedded Sign URL Parameters:
ParameterTypeRequiredDefaultDescription
signature_idstringYes—The id of the signature to get a signature url for.

​
dropbox_sign_signatures_signature_request_bulk_create_embedded_with_template

Embedded Bulk Send with Template Parameters:
ParameterTypeRequiredDefaultDescription
allow_declinebooleanNo—Allows signers to decline to sign a document if true. Defaults to false.
ccsobject[]No—Add CC email recipients. Required when a CC role exists for the Template.
client_idstringYes—Client id of the app you’re using to create this embedded signature request. Used for security purposes.
custom_fieldsobject[]No—When used together with merge fields, custom_fields allows users to add pre-filled data to their signature requests. Pre-filled data can be used with “send-once” signature requests by adding merge fields with form_fields_per_document or Text Tags while passing values back with custom_fields together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling /template/create_embedded_draft and then passing custom_fields on subsequent signature requests referencing that template.
messagestringNo—The custom message in the email that will be sent to the signers.
metadataobjectNo—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.
signer_filestringNo—signer_file is a CSV file defining values and options for signer fields. Required unless a signer_list is used, you may not use both. The CSV can have the following columns: - name: the name of the signer filling the role of RoleName - email_address: email address of the signer filling the role of RoleName - pin: the 4- to 12-character access code that will secure this signer’s signature page (optional) - sms_phone_number: An E.164 formatted phone number that will receive a code via SMS to access this signer’s signature page. (optional) By using the feature, you agree you are responsible for obtaining a signer’s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. Learn more. NOTE: Not available in test mode and requires a Standard plan or higher. - *_field: any column with a _field” suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC
signer_listobject[]No—signer_list is an array defining values and options for signer fields. Required unless a signer_file is used, you may not use both.
signing_redirect_urlstringNo—The URL you want signers redirected to after they successfully sign.
subjectstringNo—The subject in the email that will be sent to the signers.
template_idsstring[]Yes—Use template_ids to create a SignatureRequest from one or more templates, in the order in which the template will be used.
test_modebooleanNo—Whether this is a test, the signature request will not be legally binding if set to true. Defaults to false.
titlestringNo—The title you want to assign to the SignatureRequest.

​
dropbox_sign_signatures_signature_request_bulk_send_with_template

Bulk Send with Template Parameters:
ParameterTypeRequiredDefaultDescription
allow_declinebooleanNo—Allows signers to decline to sign a document if true. Defaults to false.
ccsobject[]No—Add CC email recipients. Required when a CC role exists for the Template.
client_idstringNo—The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.
custom_fieldsobject[]No—When used together with merge fields, custom_fields allows users to add pre-filled data to their signature requests. Pre-filled data can be used with “send-once” signature requests by adding merge fields with form_fields_per_document or Text Tags while passing values back with custom_fields together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling /template/create_embedded_draft and then passing custom_fields on subsequent signature requests referencing that template.
messagestringNo—The custom message in the email that will be sent to the signers.
metadataobjectNo—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.
signer_filestringNo—signer_file is a CSV file defining values and options for signer fields. Required unless a signer_list is used, you may not use both. The CSV can have the following columns: - name: the name of the signer filling the role of RoleName - email_address: email address of the signer filling the role of RoleName - pin: the 4- to 12-character access code that will secure this signer’s signature page (optional) - sms_phone_number: An E.164 formatted phone number that will receive a code via SMS to access this signer’s signature page. (optional) By using the feature, you agree you are responsible for obtaining a signer’s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. Learn more. NOTE: Not available in test mode and requires a Standard plan or higher. - *_field: any column with a _field” suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC
signer_listobject[]No—signer_list is an array defining values and options for signer fields. Required unless a signer_file is used, you may not use both.
signing_redirect_urlstringNo—The URL you want signers redirected to after they successfully sign.
subjectstringNo—The subject in the email that will be sent to the signers.
template_idsstring[]Yes—Use template_ids to create a SignatureRequest from one or more templates, in the order in which the template will be used.
test_modebooleanNo—Whether this is a test, the signature request will not be legally binding if set to true. Defaults to false.
titlestringNo—The title you want to assign to the SignatureRequest.

​
dropbox_sign_signatures_signature_request_cancel

Cancel Incomplete Signature Request Parameters:
ParameterTypeRequiredDefaultDescription
signature_request_idstringYes—The id of the incomplete SignatureRequest to cancel.

​
dropbox_sign_signatures_signature_request_create_embedded

Create Embedded Signature Request Parameters:
ParameterTypeRequiredDefaultDescription
allow_declinebooleanNo—Allows signers to decline to sign a document if true. Defaults to false.
allow_reassignbooleanNo—Allows signers to reassign their signature requests to other signers if set to true. Defaults to false. NOTE: Only available for Premium plan.
attachmentsobject[]No—A list describing the attachments
cc_email_addressesstring[]No—The email addresses that should be CCed.
client_idstringYes—Client id of the app you’re using to create this embedded signature request. Used for security purposes.
custom_fieldsobject[]No—When used together with merge fields, custom_fields allows users to add pre-filled data to their signature requests. Pre-filled data can be used with “send-once” signature requests by adding merge fields with form_fields_per_document or Text Tags while passing values back with custom_fields together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling /template/create_embedded_draft and then passing custom_fields on subsequent signature requests referencing that template.
expires_atintegerNo—When 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.
field_optionsobjectNo—This allows the requester to specify field options for a signature request.
file_urlsstring[]No—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.
filesstring[]No—Use files[] to indicate the uploaded file(s) to send for signature. This endpoint requires either files or file_urls[], but not both.
form_field_groupsobject[]No—Group information for fields defined in form_fields_per_document. String-indexed JSON array with group_label and requirement keys. form_fields_per_document must contain fields referencing a group defined in form_field_groups.
form_field_rulesobject[]No—Conditional Logic rules for fields defined in form_fields_per_document.
form_fields_per_documentobject[]No—The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: Using Form Fields per Document.) NOTE: Fields like text, dropdown, checkbox, radio, and hyperlink have additional required and optional parameters. Check out the list of additional parameters for these field types. * Text Field use SubFormFieldsPerDocumentText * Dropdown Field use SubFormFieldsPerDocumentDropdown * Hyperlink Field use SubFormFieldsPerDocumentHyperlink * Checkbox Field use SubFormFieldsPerDocumentCheckbox * Radio Field use SubFormFieldsPerDocumentRadio * Signature Field use SubFormFieldsPerDocumentSignature * Date Signed Field use SubFormFieldsPerDocumentDateSigned * Initials Field use SubFormFieldsPerDocumentInitials * Text Merge Field use SubFormFieldsPerDocumentTextMerge * Checkbox Merge Field use SubFormFieldsPerDocumentCheckboxMerge
grouped_signersobject[]No—Add Grouped Signers to your Signature Request. This endpoint requires either signers or grouped_signers, but not both.
hide_text_tagsbooleanNo—Enables automatic Text Tag removal when set to true. NOTE: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on false and instead hiding your text tags using white text or a similar approach. See the Text Tags Walkthrough for more information.
messagestringNo—The custom message in the email that will be sent to the signers.
metadataobjectNo—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.
populate_auto_fill_fieldsbooleanNo—Controls 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.
signersobject[]No—Add Signers to your Signature Request. This endpoint requires either signers or grouped_signers, but not both.
signing_optionsobjectNo—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.
subjectstringNo—The subject in the email that will be sent to the signers.
test_modebooleanNo—Whether this is a test, the signature request will not be legally binding if set to true. Defaults to false.
titlestringNo—The title you want to assign to the SignatureRequest.
use_text_tagsbooleanNo—Send with a value of true if you wish to enable Text Tags parsing in your document. Defaults to disabled, or false.

​
dropbox_sign_signatures_signature_request_create_embedded_with_template

Create Embedded Signature Request with Template Parameters:
ParameterTypeRequiredDefaultDescription
allow_declinebooleanNo—Allows signers to decline to sign a document if true. Defaults to false.
ccsobject[]No—Add CC email recipients. Required when a CC role exists for the Template.
client_idstringYes—Client id of the app you’re using to create this embedded signature request. Used for security purposes.
custom_fieldsobject[]No—An array defining values and options for custom fields. Required when a custom field exists in the Template.
file_urlsstring[]No—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.
filesstring[]No—Use files[] to indicate the uploaded file(s) to send for signature. This endpoint requires either files or file_urls[], but not both.
messagestringNo—The custom message in the email that will be sent to the signers.
metadataobjectNo—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.
populate_auto_fill_fieldsbooleanNo—Controls 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.
signersobject[]Yes—Add Signers to your Templated-based Signature Request.
signing_optionsobjectNo—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.
subjectstringNo—The subject in the email that will be sent to the signers.
template_idsstring[]Yes—Use template_ids to create a SignatureRequest from one or more templates, in the order in which the template will be used.
test_modebooleanNo—Whether this is a test, the signature request will not be legally binding if set to true. Defaults to false.
titlestringNo—The title you want to assign to the SignatureRequest.

​
dropbox_sign_signatures_signature_request_edit

Edit Signature Request Parameters:
ParameterTypeRequiredDefaultDescription
signature_request_idstringYes—The id of the SignatureRequest to edit.
allow_declinebooleanNo—Allows signers to decline to sign a document if true. Defaults to false.
allow_reassignbooleanNo—Allows signers to reassign their signature requests to other signers if set to true. Defaults to false. NOTE: Only available for Premium plan and higher.
attachmentsobject[]No—A list describing the attachments
cc_email_addressesstring[]No—The email addresses that should be CCed.
client_idstringNo—The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.
custom_fieldsobject[]No—When used together with merge fields, custom_fields allows users to add pre-filled data to their signature requests. Pre-filled data can be used with “send-once” signature requests by adding merge fields with form_fields_per_document or Text Tags while passing values back with custom_fields together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling /template/create_embedded_draft and then passing custom_fields on subsequent signature requests referencing that template.
expires_atintegerNo—When 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.
field_optionsobjectNo—This allows the requester to specify field options for a signature request.
file_urlsstring[]No—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.
filesstring[]No—Use files[] to indicate the uploaded file(s) to send for signature. This endpoint requires either files or file_urls[], but not both.
form_field_groupsobject[]No—Group information for fields defined in form_fields_per_document. String-indexed JSON array with group_label and requirement keys. form_fields_per_document must contain fields referencing a group defined in form_field_groups.
form_field_rulesobject[]No—Conditional Logic rules for fields defined in form_fields_per_document.
form_fields_per_documentobject[]No—The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: Using Form Fields per Document.) NOTE: Fields like text, dropdown, checkbox, radio, and hyperlink have additional required and optional parameters. Check out the list of additional parameters for these field types. * Text Field use SubFormFieldsPerDocumentText * Dropdown Field use SubFormFieldsPerDocumentDropdown * Hyperlink Field use SubFormFieldsPerDocumentHyperlink * Checkbox Field use SubFormFieldsPerDocumentCheckbox * Radio Field use SubFormFieldsPerDocumentRadio * Signature Field use SubFormFieldsPerDocumentSignature * Date Signed Field use SubFormFieldsPerDocumentDateSigned * Initials Field use SubFormFieldsPerDocumentInitials * Text Merge Field use SubFormFieldsPerDocumentTextMerge * Checkbox Merge Field use SubFormFieldsPerDocumentCheckboxMerge
grouped_signersobject[]No—Add Grouped Signers to your Signature Request. This endpoint requires either signers or grouped_signers, but not both.
hide_text_tagsbooleanNo—Enables automatic Text Tag removal when set to true. NOTE: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on false and instead hiding your text tags using white text or a similar approach. See the Text Tags Walkthrough for more information.
is_eidbooleanNo—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.<br> 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.
messagestringNo—The custom message in the email that will be sent to the signers.
metadataobjectNo—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.
signersobject[]No—Add Signers to your Signature Request. This endpoint requires either signers or grouped_signers, but not both.
signing_optionsobjectNo—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.
signing_redirect_urlstringNo—The URL you want signers redirected to after they successfully sign.
subjectstringNo—The subject in the email that will be sent to the signers.
test_modebooleanNo—Whether this is a test, the signature request will not be legally binding if set to true. Defaults to false.
titlestringNo—The title you want to assign to the SignatureRequest.
use_text_tagsbooleanNo—Send with a value of true if you wish to enable Text Tags parsing in your document. Defaults to disabled, or false.

​
dropbox_sign_signatures_signature_request_edit_embedded

Edit Embedded Signature Request Parameters:
ParameterTypeRequiredDefaultDescription
signature_request_idstringYes—The id of the SignatureRequest to edit.
allow_declinebooleanNo—Allows signers to decline to sign a document if true. Defaults to false.
allow_reassignbooleanNo—Allows signers to reassign their signature requests to other signers if set to true. Defaults to false. NOTE: Only available for Premium plan.
attachmentsobject[]No—A list describing the attachments
cc_email_addressesstring[]No—The email addresses that should be CCed.
client_idstringYes—Client id of the app you’re using to create this embedded signature request. Used for security purposes.
custom_fieldsobject[]No—When used together with merge fields, custom_fields allows users to add pre-filled data to their signature requests. Pre-filled data can be used with “send-once” signature requests by adding merge fields with form_fields_per_document or Text Tags while passing values back with custom_fields together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling /template/create_embedded_draft and then passing custom_fields on subsequent signature requests referencing that template.
expires_atintegerNo—When 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.
field_optionsobjectNo—This allows the requester to specify field options for a signature request.
file_urlsstring[]No—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.
filesstring[]No—Use files[] to indicate the uploaded file(s) to send for signature. This endpoint requires either files or file_urls[], but not both.
form_field_groupsobject[]No—Group information for fields defined in form_fields_per_document. String-indexed JSON array with group_label and requirement keys. form_fields_per_document must contain fields referencing a group defined in form_field_groups.
form_field_rulesobject[]No—Conditional Logic rules for fields defined in form_fields_per_document.
form_fields_per_documentobject[]No—The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: Using Form Fields per Document.) NOTE: Fields like text, dropdown, checkbox, radio, and hyperlink have additional required and optional parameters. Check out the list of additional parameters for these field types. * Text Field use SubFormFieldsPerDocumentText * Dropdown Field use SubFormFieldsPerDocumentDropdown * Hyperlink Field use SubFormFieldsPerDocumentHyperlink * Checkbox Field use SubFormFieldsPerDocumentCheckbox * Radio Field use SubFormFieldsPerDocumentRadio * Signature Field use SubFormFieldsPerDocumentSignature * Date Signed Field use SubFormFieldsPerDocumentDateSigned * Initials Field use SubFormFieldsPerDocumentInitials * Text Merge Field use SubFormFieldsPerDocumentTextMerge * Checkbox Merge Field use SubFormFieldsPerDocumentCheckboxMerge
grouped_signersobject[]No—Add Grouped Signers to your Signature Request. This endpoint requires either signers or grouped_signers, but not both.
hide_text_tagsbooleanNo—Enables automatic Text Tag removal when set to true. NOTE: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on false and instead hiding your text tags using white text or a similar approach. See the Text Tags Walkthrough for more information.
messagestringNo—The custom message in the email that will be sent to the signers.
metadataobjectNo—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.
populate_auto_fill_fieldsbooleanNo—Controls 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.
signersobject[]No—Add Signers to your Signature Request. This endpoint requires either signers or grouped_signers, but not both.
signing_optionsobjectNo—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.
subjectstringNo—The subject in the email that will be sent to the signers.
test_modebooleanNo—Whether this is a test, the signature request will not be legally binding if set to true. Defaults to false.
titlestringNo—The title you want to assign to the SignatureRequest.
use_text_tagsbooleanNo—Send with a value of true if you wish to enable Text Tags parsing in your document. Defaults to disabled, or false.

​
dropbox_sign_signatures_signature_request_edit_embedded_with_template

Edit Embedded Signature Request with Template Parameters:
ParameterTypeRequiredDefaultDescription
signature_request_idstringYes—The id of the SignatureRequest to edit.
allow_declinebooleanNo—Allows signers to decline to sign a document if true. Defaults to false.
ccsobject[]No—Add CC email recipients. Required when a CC role exists for the Template.
client_idstringYes—Client id of the app you’re using to create this embedded signature request. Used for security purposes.
custom_fieldsobject[]No—An array defining values and options for custom fields. Required when a custom field exists in the Template.
file_urlsstring[]No—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.
filesstring[]No—Use files[] to indicate the uploaded file(s) to send for signature. This endpoint requires either files or file_urls[], but not both.
messagestringNo—The custom message in the email that will be sent to the signers.
metadataobjectNo—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.
populate_auto_fill_fieldsbooleanNo—Controls 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.
signersobject[]Yes—Add Signers to your Templated-based Signature Request.
signing_optionsobjectNo—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.
subjectstringNo—The subject in the email that will be sent to the signers.
template_idsstring[]Yes—Use template_ids to create a SignatureRequest from one or more templates, in the order in which the template will be used.
test_modebooleanNo—Whether this is a test, the signature request will not be legally binding if set to true. Defaults to false.
titlestringNo—The title you want to assign to the SignatureRequest.

​
dropbox_sign_signatures_signature_request_edit_with_template

Edit Signature Request With Template Parameters:
ParameterTypeRequiredDefaultDescription
signature_request_idstringYes—The id of the SignatureRequest to edit.
allow_declinebooleanNo—Allows signers to decline to sign a document if true. Defaults to false.
ccsobject[]No—Add CC email recipients. Required when a CC role exists for the Template.
client_idstringNo—Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.
custom_fieldsobject[]No—An array defining values and options for custom fields. Required when a custom field exists in the Template.
file_urlsstring[]No—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.
filesstring[]No—Use files[] to indicate the uploaded file(s) to send for signature. This endpoint requires either files or file_urls[], but not both.
is_eidbooleanNo—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.<br> 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.
messagestringNo—The custom message in the email that will be sent to the signers.
metadataobjectNo—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.
signersobject[]Yes—Add Signers to your Templated-based Signature Request.
signing_optionsobjectNo—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.
signing_redirect_urlstringNo—The URL you want signers redirected to after they successfully sign.
subjectstringNo—The subject in the email that will be sent to the signers.
template_idsstring[]Yes—Use template_ids to create a SignatureRequest from one or more templates, in the order in which the template will be used.
test_modebooleanNo—Whether this is a test, the signature request will not be legally binding if set to true. Defaults to false.
titlestringNo—The title you want to assign to the SignatureRequest.

​
dropbox_sign_signatures_signature_request_files

Download Files Parameters:
ParameterTypeRequiredDefaultDescription
signature_request_idstringYes—The id of the SignatureRequest to retrieve.
file_typestringNo—Set to pdf for a single merged document or zip for a collection of individual documents.

​
dropbox_sign_signatures_signature_request_files_as_data_uri

Download Files as Data Uri Parameters:
ParameterTypeRequiredDefaultDescription
signature_request_idstringYes—The id of the SignatureRequest to retrieve.

​
dropbox_sign_signatures_signature_request_files_as_file_url

Download Files as File Url Parameters:
ParameterTypeRequiredDefaultDescription
signature_request_idstringYes—The id of the SignatureRequest to retrieve.
force_downloadintegerNo—By default when opening the file_url a browser will download the PDF and save it locally. When set to 0 the PDF file will be displayed in the browser.

​
dropbox_sign_signatures_signature_request_get

Get Signature Request Parameters:
ParameterTypeRequiredDefaultDescription
signature_request_idstringYes—The id of the SignatureRequest to retrieve.

​
dropbox_sign_signatures_signature_request_list

List Signature Requests Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringNo—Which account to return SignatureRequests for. Must be a team member. Use all to indicate all team members. Defaults to your account.
pageintegerNo—Which page number of the SignatureRequest List to return. Defaults to 1.
page_sizeintegerNo—Number of objects to be returned per page. Must be between 1 and 100. Default is 20.
querystringNo—String that includes search terms and/or fields to be used to filter the SignatureRequest objects.

​
dropbox_sign_signatures_signature_request_release_hold

Release On-Hold Signature Request Parameters:
ParameterTypeRequiredDefaultDescription
signature_request_idstringYes—The id of the SignatureRequest to release.

​
dropbox_sign_signatures_signature_request_remind

Send Request Reminder Parameters:
ParameterTypeRequiredDefaultDescription
signature_request_idstringYes—The id of the SignatureRequest to send a reminder for.
email_addressstringYes—The email address of the signer to send a reminder to.
namestringNo—The name of the signer to send a reminder to. Include if two or more signers share an email address.

​
dropbox_sign_signatures_signature_request_remove

Remove Signature Request Access Parameters:
ParameterTypeRequiredDefaultDescription
signature_request_idstringYes—The id of the SignatureRequest to remove.

​
dropbox_sign_signatures_signature_request_send

Send Signature Request Parameters:
ParameterTypeRequiredDefaultDescription
allow_declinebooleanNo—Allows signers to decline to sign a document if true. Defaults to false.
allow_reassignbooleanNo—Allows signers to reassign their signature requests to other signers if set to true. Defaults to false. NOTE: Only available for Premium plan and higher.
attachmentsobject[]No—A list describing the attachments
cc_email_addressesstring[]No—The email addresses that should be CCed.
client_idstringNo—The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.
custom_fieldsobject[]No—When used together with merge fields, custom_fields allows users to add pre-filled data to their signature requests. Pre-filled data can be used with “send-once” signature requests by adding merge fields with form_fields_per_document or Text Tags while passing values back with custom_fields together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling /template/create_embedded_draft and then passing custom_fields on subsequent signature requests referencing that template.
expires_atintegerNo—When 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.
field_optionsobjectNo—This allows the requester to specify field options for a signature request.
file_urlsstring[]No—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.
filesstring[]No—Use files[] to indicate the uploaded file(s) to send for signature. This endpoint requires either files or file_urls[], but not both.
form_field_groupsobject[]No—Group information for fields defined in form_fields_per_document. String-indexed JSON array with group_label and requirement keys. form_fields_per_document must contain fields referencing a group defined in form_field_groups.
form_field_rulesobject[]No—Conditional Logic rules for fields defined in form_fields_per_document.
form_fields_per_documentobject[]No—The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: Using Form Fields per Document.) NOTE: Fields like text, dropdown, checkbox, radio, and hyperlink have additional required and optional parameters. Check out the list of additional parameters for these field types. * Text Field use SubFormFieldsPerDocumentText * Dropdown Field use SubFormFieldsPerDocumentDropdown * Hyperlink Field use SubFormFieldsPerDocumentHyperlink * Checkbox Field use SubFormFieldsPerDocumentCheckbox * Radio Field use SubFormFieldsPerDocumentRadio * Signature Field use SubFormFieldsPerDocumentSignature * Date Signed Field use SubFormFieldsPerDocumentDateSigned * Initials Field use SubFormFieldsPerDocumentInitials * Text Merge Field use SubFormFieldsPerDocumentTextMerge * Checkbox Merge Field use SubFormFieldsPerDocumentCheckboxMerge
grouped_signersobject[]No—Add Grouped Signers to your Signature Request. This endpoint requires either signers or grouped_signers, but not both.
hide_text_tagsbooleanNo—Enables automatic Text Tag removal when set to true. NOTE: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on false and instead hiding your text tags using white text or a similar approach. See the Text Tags Walkthrough for more information.
is_eidbooleanNo—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.<br> 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.
messagestringNo—The custom message in the email that will be sent to the signers.
metadataobjectNo—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.
signersobject[]No—Add Signers to your Signature Request. This endpoint requires either signers or grouped_signers, but not both.
signing_optionsobjectNo—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.
signing_redirect_urlstringNo—The URL you want signers redirected to after they successfully sign.
subjectstringNo—The subject in the email that will be sent to the signers.
test_modebooleanNo—Whether this is a test, the signature request will not be legally binding if set to true. Defaults to false.
titlestringNo—The title you want to assign to the SignatureRequest.
use_text_tagsbooleanNo—Send with a value of true if you wish to enable Text Tags parsing in your document. Defaults to disabled, or false.

​
dropbox_sign_signatures_signature_request_send_with_template

Send with Template Parameters:
ParameterTypeRequiredDefaultDescription
allow_declinebooleanNo—Allows signers to decline to sign a document if true. Defaults to false.
ccsobject[]No—Add CC email recipients. Required when a CC role exists for the Template.
client_idstringNo—Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.
custom_fieldsobject[]No—An array defining values and options for custom fields. Required when a custom field exists in the Template.
file_urlsstring[]No—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.
filesstring[]No—Use files[] to indicate the uploaded file(s) to send for signature. This endpoint requires either files or file_urls[], but not both.
is_eidbooleanNo—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.<br> 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.
messagestringNo—The custom message in the email that will be sent to the signers.
metadataobjectNo—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.
signersobject[]Yes—Add Signers to your Templated-based Signature Request.
signing_optionsobjectNo—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.
signing_redirect_urlstringNo—The URL you want signers redirected to after they successfully sign.
subjectstringNo—The subject in the email that will be sent to the signers.
template_idsstring[]Yes—Use template_ids to create a SignatureRequest from one or more templates, in the order in which the template will be used.
test_modebooleanNo—Whether this is a test, the signature request will not be legally binding if set to true. Defaults to false.
titlestringNo—The title you want to assign to the SignatureRequest.

​
dropbox_sign_signatures_signature_request_update

Update Signature Request Parameters:
ParameterTypeRequiredDefaultDescription
signature_request_idstringYes—The id of the SignatureRequest to update.
email_addressstringNo—The new email address for the recipient. This will generate a new signature_id value. NOTE: Optional if name is provided.
expires_atintegerNo—The new time when 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.
namestringNo—The new name for the recipient. NOTE: Optional if email_address is provided.
signature_idstringYes—The signature ID for the recipient.

​
dropbox_sign_signatures_template_add_user

Add User to Template Parameters:
ParameterTypeRequiredDefaultDescription
template_idstringYes—The id of the Template to give the Account access to.
account_idstringNo—The id of the Account to give access to the Template. NOTE: The account id prevails if email address is also provided.
email_addressstringNo—The email address of the Account to give access to the Template. NOTE: The account id prevails if it is also provided.
skip_notificationbooleanNo—If set to true, the user does not receive an email notification when a template has been shared with them. Defaults to false.

​
dropbox_sign_signatures_template_create

Create Template Parameters:
ParameterTypeRequiredDefaultDescription
allow_reassignbooleanNo—Allows signers to reassign their signature requests to other signers if set to true. Defaults to false. NOTE: Only available for Premium plan and higher.
attachmentsobject[]No—A list describing the attachments
cc_rolesstring[]No—The CC roles that must be assigned when using the template to send a signature request
client_idstringNo—Client id of the app you’re using to create this draft. Used to apply the branding and callback url defined for the app.
field_optionsobjectNo—This allows the requester to specify field options for a signature request.
file_urlsstring[]No—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.
filesstring[]No—Use files[] to indicate the uploaded file(s) to send for signature. This endpoint requires either files or file_urls[], but not both.
form_field_groupsobject[]No—Group information for fields defined in form_fields_per_document. String-indexed JSON array with group_label and requirement keys. form_fields_per_document must contain fields referencing a group defined in form_field_groups.
form_field_rulesobject[]No—Conditional Logic rules for fields defined in form_fields_per_document.
form_fields_per_documentobject[]Yes—The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: Using Form Fields per Document.) NOTE: Fields like text, dropdown, checkbox, radio, and hyperlink have additional required and optional parameters. Check out the list of additional parameters for these field types. * Text Field use SubFormFieldsPerDocumentText * Dropdown Field use SubFormFieldsPerDocumentDropdown * Hyperlink Field use SubFormFieldsPerDocumentHyperlink * Checkbox Field use SubFormFieldsPerDocumentCheckbox * Radio Field use SubFormFieldsPerDocumentRadio * Signature Field use SubFormFieldsPerDocumentSignature * Date Signed Field use SubFormFieldsPerDocumentDateSigned * Initials Field use SubFormFieldsPerDocumentInitials * Text Merge Field use SubFormFieldsPerDocumentTextMerge * Checkbox Merge Field use SubFormFieldsPerDocumentCheckboxMerge
merge_fieldsobject[]No—Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the custom_fields parameter. If the signature request using that template does not pass a value into a merge field, then an empty field remains in the document.
messagestringNo—The default template email message.
metadataobjectNo—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.
signer_rolesobject[]Yes—An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
subjectstringNo—The template title (alias).
test_modebooleanNo—Whether this is a test, the signature request created from this draft will not be legally binding if set to true. Defaults to false.
titlestringNo—The title you want to assign to the SignatureRequest.
use_preexisting_fieldsbooleanNo—Enable the detection of predefined PDF fields by setting the use_preexisting_fields to true (defaults to disabled, or false).

​
dropbox_sign_signatures_template_create_embedded_draft

Create Embedded Template Draft Parameters:
ParameterTypeRequiredDefaultDescription
allow_ccsbooleanNo—This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template.
allow_reassignbooleanNo—Allows signers to reassign their signature requests to other signers if set to true. Defaults to false. NOTE: Only available for Premium plan and higher.
attachmentsobject[]No—A list describing the attachments
cc_rolesstring[]No—The CC roles that must be assigned when using the template to send a signature request
client_idstringYes—Client id of the app you’re using to create this draft. Used to apply the branding and callback url defined for the app.
editor_optionsobjectNo—This allows the requester to specify editor options when a preparing a document
field_optionsobjectNo—This allows the requester to specify field options for a signature request.
file_urlsstring[]No—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.
filesstring[]No—Use files[] to indicate the uploaded file(s) to send for signature. This endpoint requires either files or file_urls[], but not both.
force_signer_rolesbooleanNo—Provide users the ability to review/edit the template signer roles.
force_subject_messagebooleanNo—Provide users the ability to review/edit the template subject and message.
form_field_groupsobject[]No—Group information for fields defined in form_fields_per_document. String-indexed JSON array with group_label and requirement keys. form_fields_per_document must contain fields referencing a group defined in form_field_groups.
form_field_rulesobject[]No—Conditional Logic rules for fields defined in form_fields_per_document.
form_fields_per_documentobject[]No—The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: Using Form Fields per Document.) NOTE: Fields like text, dropdown, checkbox, radio, and hyperlink have additional required and optional parameters. Check out the list of additional parameters for these field types. * Text Field use SubFormFieldsPerDocumentText * Dropdown Field use SubFormFieldsPerDocumentDropdown * Hyperlink Field use SubFormFieldsPerDocumentHyperlink * Checkbox Field use SubFormFieldsPerDocumentCheckbox * Radio Field use SubFormFieldsPerDocumentRadio * Signature Field use SubFormFieldsPerDocumentSignature * Date Signed Field use SubFormFieldsPerDocumentDateSigned * Initials Field use SubFormFieldsPerDocumentInitials * Text Merge Field use SubFormFieldsPerDocumentTextMerge * Checkbox Merge Field use SubFormFieldsPerDocumentCheckboxMerge
merge_fieldsobject[]No—Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the custom_fields parameter. If the signature request using that template does not pass a value into a merge field, then an empty field remains in the document.
messagestringNo—The default template email message.
metadataobjectNo—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.
show_previewbooleanNo—This allows the requester to enable the editor/preview experience. - show_preview=true: Allows requesters to enable the editor/preview experience. - show_preview=false: Allows requesters to disable the editor/preview experience.
show_progress_stepperbooleanNo—When only one step remains in the signature request process and this parameter is set to false then the progress stepper will be hidden.
signer_rolesobject[]No—An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
skip_me_nowbooleanNo—Disables the “Me (Now)” option for the person preparing the document. Does not work with type send_document. Defaults to false.
subjectstringNo—The template title (alias).
test_modebooleanNo—Whether this is a test, the signature request created from this draft will not be legally binding if set to true. Defaults to false.
titlestringNo—The title you want to assign to the SignatureRequest.
use_preexisting_fieldsbooleanNo—Enable the detection of predefined PDF fields by setting the use_preexisting_fields to true (defaults to disabled, or false).

​
dropbox_sign_signatures_template_delete

Delete Template Parameters:
ParameterTypeRequiredDefaultDescription
template_idstringYes—The id of the Template to delete.

​
dropbox_sign_signatures_template_files

Get Template Files Parameters:
ParameterTypeRequiredDefaultDescription
template_idstringYes—The id of the template files to retrieve.
file_typestringNo—Set to pdf for a single merged document or zip for a collection of individual documents.

​
dropbox_sign_signatures_template_files_as_data_uri

Get Template Files as Data Uri Parameters:
ParameterTypeRequiredDefaultDescription
template_idstringYes—The id of the template files to retrieve.

​
dropbox_sign_signatures_template_files_as_file_url

Get Template Files as File Url Parameters:
ParameterTypeRequiredDefaultDescription
template_idstringYes—The id of the template files to retrieve.
force_downloadintegerNo—By default when opening the file_url a browser will download the PDF and save it locally. When set to 0 the PDF file will be displayed in the browser.

​
dropbox_sign_signatures_template_get

Get Template Parameters:
ParameterTypeRequiredDefaultDescription
template_idstringYes—The id of the Template to retrieve.

​
dropbox_sign_signatures_template_list

List Templates Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringNo—Which account to return Templates for. Must be a team member. Use all to indicate all team members. Defaults to your account.
pageintegerNo—Which page number of the Template List to return. Defaults to 1.
page_sizeintegerNo—Number of objects to be returned per page. Must be between 1 and 100. Default is 20.
querystringNo—String that includes search terms and/or fields to be used to filter the Template objects.

​
dropbox_sign_signatures_template_remove_user

Remove User from Template Parameters:
ParameterTypeRequiredDefaultDescription
template_idstringYes—The id of the Template to remove the Account’s access to.
account_idstringNo—The id or email address of the Account to remove access to the Template. The account id prevails if both are provided.
email_addressstringNo—The id or email address of the Account to remove access to the Template. The account id prevails if both are provided.

​
dropbox_sign_signatures_template_update_files

Update Template Files Parameters:
ParameterTypeRequiredDefaultDescription
template_idstringYes—The ID of the template whose files to update.
client_idstringNo—Client id of the app you’re using to update this template.
file_urlsstring[]No—Use file_urls[] to have Dropbox Sign download the file(s) to use for the template. This endpoint requires either files or file_urls[], but not both.
filesstring[]No—Use files[] to indicate the uploaded file(s) to use for the template. This endpoint requires either files or file_urls[], but not both.
messagestringNo—The new default template email message.
subjectstringNo—The new default template email subject.
test_modebooleanNo—Whether this is a test, the signature request created from this draft will not be legally binding if set to true. Defaults to false.

​
dropbox_sign_signatures_unclaimed_draft_create

Create Unclaimed Draft Parameters:
ParameterTypeRequiredDefaultDescription
allow_declinebooleanNo—Allows signers to decline to sign a document if true. Defaults to false.
attachmentsobject[]No—A list describing the attachments
cc_email_addressesstring[]No—The email addresses that should be CCed.
client_idstringNo—Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
custom_fieldsobject[]No—When used together with merge fields, custom_fields allows users to add pre-filled data to their signature requests. Pre-filled data can be used with “send-once” signature requests by adding merge fields with form_fields_per_document or Text Tags while passing values back with custom_fields together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling /template/create_embedded_draft and then passing custom_fields on subsequent signature requests referencing that template.
expires_atintegerNo—When 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. NOTE: This does not correspond to the expires_at returned in the response.
field_optionsobjectNo—This allows the requester to specify field options for a signature request.
file_urlsstring[]No—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.
filesstring[]No—Use files[] to indicate the uploaded file(s) to send for signature. This endpoint requires either files or file_urls[], but not both.
form_field_groupsobject[]No—Group information for fields defined in form_fields_per_document. String-indexed JSON array with group_label and requirement keys. form_fields_per_document must contain fields referencing a group defined in form_field_groups.
form_field_rulesobject[]No—Conditional Logic rules for fields defined in form_fields_per_document.
form_fields_per_documentobject[]No—The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: Using Form Fields per Document.) NOTE: Fields like text, dropdown, checkbox, radio, and hyperlink have additional required and optional parameters. Check out the list of additional parameters for these field types. * Text Field use SubFormFieldsPerDocumentText * Dropdown Field use SubFormFieldsPerDocumentDropdown * Hyperlink Field use SubFormFieldsPerDocumentHyperlink * Checkbox Field use SubFormFieldsPerDocumentCheckbox * Radio Field use SubFormFieldsPerDocumentRadio * Signature Field use SubFormFieldsPerDocumentSignature * Date Signed Field use SubFormFieldsPerDocumentDateSigned * Initials Field use SubFormFieldsPerDocumentInitials * Text Merge Field use SubFormFieldsPerDocumentTextMerge * Checkbox Merge Field use SubFormFieldsPerDocumentCheckboxMerge
hide_text_tagsbooleanNo—Send with a value of true if you wish to enable automatic Text Tag removal. Defaults to false. When using Text Tags it is preferred that you set this to false and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the Text Tags walkthrough for more details.
messagestringNo—The custom message in the email that will be sent to the signers.
metadataobjectNo—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.
show_progress_stepperbooleanNo—When only one step remains in the signature request process and this parameter is set to false then the progress stepper will be hidden.
signersobject[]No—Add Signers to your Unclaimed Draft Signature Request.
signing_optionsobjectNo—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.
signing_redirect_urlstringNo—The URL you want signers redirected to after they successfully sign.
subjectstringNo—The subject in the email that will be sent to the signers.
test_modebooleanNo—Whether this is a test, the signature request created from this draft will not be legally binding if set to true. Defaults to false.
typestringYes—The type of unclaimed draft to create. Use send_document to create a claimable file, and request_signature for a claimable signature request. If the type is request_signature then signers name and email_address are not optional.
use_preexisting_fieldsbooleanNo—Set use_text_tags to true to enable Text Tags parsing in your document (defaults to disabled, or false). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the use_preexisting_fields to true (defaults to disabled, or false). Currently we only support use of either use_text_tags or use_preexisting_fields parameter, not both.
use_text_tagsbooleanNo—Set use_text_tags to true to enable Text Tags parsing in your document (defaults to disabled, or false). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the use_preexisting_fields to true (defaults to disabled, or false). Currently we only support use of either use_text_tags or use_preexisting_fields parameter, not both.

​
dropbox_sign_signatures_unclaimed_draft_create_embedded

Create Embedded Unclaimed Draft Parameters:
ParameterTypeRequiredDefaultDescription
allow_ccsbooleanNo—This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.
allow_declinebooleanNo—Allows signers to decline to sign a document if true. Defaults to false.
allow_reassignbooleanNo—Allows signers to reassign their signature requests to other signers if set to true. Defaults to false. NOTE: Only available for Premium plan and higher.
attachmentsobject[]No—A list describing the attachments
cc_email_addressesstring[]No—The email addresses that should be CCed.
client_idstringYes—Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
custom_fieldsobject[]No—When used together with merge fields, custom_fields allows users to add pre-filled data to their signature requests. Pre-filled data can be used with “send-once” signature requests by adding merge fields with form_fields_per_document or Text Tags while passing values back with custom_fields together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling /template/create_embedded_draft and then passing custom_fields on subsequent signature requests referencing that template.
editor_optionsobjectNo—This allows the requester to specify editor options when a preparing a document
expires_atintegerNo—When 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. NOTE: This does not correspond to the expires_at returned in the response.
field_optionsobjectNo—This allows the requester to specify field options for a signature request.
file_urlsstring[]No—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.
filesstring[]No—Use files[] to indicate the uploaded file(s) to send for signature. This endpoint requires either files or file_urls[], but not both.
force_signer_pagebooleanNo—Provide users the ability to review/edit the signers.
force_subject_messagebooleanNo—Provide users the ability to review/edit the subject and message.
form_field_groupsobject[]No—Group information for fields defined in form_fields_per_document. String-indexed JSON array with group_label and requirement keys. form_fields_per_document must contain fields referencing a group defined in form_field_groups.
form_field_rulesobject[]No—Conditional Logic rules for fields defined in form_fields_per_document.
form_fields_per_documentobject[]No—The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: Using Form Fields per Document.) NOTE: Fields like text, dropdown, checkbox, radio, and hyperlink have additional required and optional parameters. Check out the list of additional parameters for these field types. * Text Field use SubFormFieldsPerDocumentText * Dropdown Field use SubFormFieldsPerDocumentDropdown * Hyperlink Field use SubFormFieldsPerDocumentHyperlink * Checkbox Field use SubFormFieldsPerDocumentCheckbox * Radio Field use SubFormFieldsPerDocumentRadio * Signature Field use SubFormFieldsPerDocumentSignature * Date Signed Field use SubFormFieldsPerDocumentDateSigned * Initials Field use SubFormFieldsPerDocumentInitials * Text Merge Field use SubFormFieldsPerDocumentTextMerge * Checkbox Merge Field use SubFormFieldsPerDocumentCheckboxMerge
hide_text_tagsbooleanNo—Send with a value of true if you wish to enable automatic Text Tag removal. Defaults to false. When using Text Tags it is preferred that you set this to false and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the Text Tags walkthrough for more details.
hold_requestbooleanNo—The request from this draft will not automatically send to signers post-claim if set to true. Requester must release the request from hold when ready to send. Defaults to false.
is_for_embedded_signingbooleanNo—The request created from this draft will also be signable in embedded mode if set to true. Defaults to false.
messagestringNo—The custom message in the email that will be sent to the signers.
metadataobjectNo—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.
populate_auto_fill_fieldsbooleanNo—Controls 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.
requester_email_addressstringYes—The email address of the user that should be designated as the requester of this draft, if the draft type is request_signature.
requesting_redirect_urlstringNo—The URL you want signers redirected to after they successfully request a signature.
show_previewbooleanNo—This allows the requester to enable the editor/preview experience. - show_preview=true: Allows requesters to enable the editor/preview experience. - show_preview=false: Allows requesters to disable the editor/preview experience.
show_progress_stepperbooleanNo—When only one step remains in the signature request process and this parameter is set to false then the progress stepper will be hidden.
signersobject[]No—Add Signers to your Unclaimed Draft Signature Request.
signing_optionsobjectNo—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.
signing_redirect_urlstringNo—The URL you want signers redirected to after they successfully sign.
skip_me_nowbooleanNo—Disables the “Me (Now)” option for the person preparing the document. Does not work with type send_document. Defaults to false.
subjectstringNo—The subject in the email that will be sent to the signers.
test_modebooleanNo—Whether this is a test, the signature request created from this draft will not be legally binding if set to true. Defaults to false.
typestringNo—The type of the draft. By default this is request_signature, but you can set it to send_document if you want to self sign a document and download it.
use_preexisting_fieldsbooleanNo—Set use_text_tags to true to enable Text Tags parsing in your document (defaults to disabled, or false). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the use_preexisting_fields to true (defaults to disabled, or false). Currently we only support use of either use_text_tags or use_preexisting_fields parameter, not both.
use_text_tagsbooleanNo—Set use_text_tags to true to enable Text Tags parsing in your document (defaults to disabled, or false). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the use_preexisting_fields to true (defaults to disabled, or false). Currently we only support use of either use_text_tags or use_preexisting_fields parameter, not both.

​
dropbox_sign_signatures_unclaimed_draft_create_embedded_with_template

Create Embedded Unclaimed Draft with Template Parameters:
ParameterTypeRequiredDefaultDescription
allow_ccsbooleanNo—This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.
allow_declinebooleanNo—Allows signers to decline to sign a document if true. Defaults to false.
allow_reassignbooleanNo—Allows signers to reassign their signature requests to other signers if set to true. Defaults to false. NOTE: Only available for Premium plan and higher.
ccsobject[]No—Add CC email recipients. Required when a CC role exists for the Template.
client_idstringYes—Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
custom_fieldsobject[]No—An array defining values and options for custom fields. Required when a custom field exists in the Template.
editor_optionsobjectNo—This allows the requester to specify editor options when a preparing a document
field_optionsobjectNo—This allows the requester to specify field options for a signature request.
file_urlsstring[]No—Use file_urls[] to append additional files to the signature request being created from the template. Dropbox Sign will download the file, then parse it for text tags, and append to the signature request. Text tags for signers not on the template(s) will be ignored. files or file_urls[] is required, but not both.
filesstring[]No—Use files[] to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for text tags and append it to the signature request. Text tags for signers not on the template(s) will be ignored. files or file_urls[] is required, but not both.
force_signer_rolesbooleanNo—Provide users the ability to review/edit the template signer roles.
force_subject_messagebooleanNo—Provide users the ability to review/edit the template subject and message.
hold_requestbooleanNo—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 false.
is_for_embedded_signingbooleanNo—The request created from this draft will also be signable in embedded mode if set to true. Defaults to false.
messagestringNo—The custom message in the email that will be sent to the signers.
metadataobjectNo—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.
populate_auto_fill_fieldsbooleanNo—Controls 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.
preview_onlybooleanNo—This allows the requester to enable the preview experience (i.e. does not allow the requester’s end user to add any additional fields via the editor). - preview_only=true: Allows requesters to enable the preview only experience. - preview_only=false: Allows requesters to disable the preview only experience. NOTE: This parameter overwrites show_preview=1 (if set).
requester_email_addressstringYes—The email address of the user that should be designated as the requester of this draft.
requesting_redirect_urlstringNo—The URL you want signers redirected to after they successfully request a signature.
show_previewbooleanNo—This allows the requester to enable the editor/preview experience. - show_preview=true: Allows requesters to enable the editor/preview experience. - show_preview=false: Allows requesters to disable the editor/preview experience.
show_progress_stepperbooleanNo—When only one step remains in the signature request process and this parameter is set to false then the progress stepper will be hidden.
signersobject[]No—Add Signers to your Templated-based Signature Request.
signing_optionsobjectNo—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.
signing_redirect_urlstringNo—The URL you want signers redirected to after they successfully sign.
skip_me_nowbooleanNo—Disables the “Me (Now)” option for the person preparing the document. Does not work with type send_document. Defaults to false.
subjectstringNo—The subject in the email that will be sent to the signers.
template_idsstring[]Yes—Use template_ids to create a SignatureRequest from one or more templates, in the order in which the templates will be used.
test_modebooleanNo—Whether this is a test, the signature request created from this draft will not be legally binding if set to true. Defaults to false.
titlestringNo—The title you want to assign to the SignatureRequest.

​
dropbox_sign_signatures_unclaimed_draft_edit_and_resend

Edit and Resend Unclaimed Draft Parameters:
ParameterTypeRequiredDefaultDescription
signature_request_idstringYes—The ID of the signature request to edit and resend.
client_idstringYes—Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
editor_optionsobjectNo—This allows the requester to specify editor options when a preparing a document
is_for_embedded_signingbooleanNo—The request created from this draft will also be signable in embedded mode if set to true.
requester_email_addressstringNo—The email address of the user that should be designated as the requester of this draft. If not set, original requester’s email address will be used.
requesting_redirect_urlstringNo—The URL you want signers redirected to after they successfully request a signature.
show_progress_stepperbooleanNo—When only one step remains in the signature request process and this parameter is set to false then the progress stepper will be hidden.
signing_redirect_urlstringNo—The URL you want signers redirected to after they successfully sign.
test_modebooleanNo—Whether this is a test, the signature request created from this draft will not be legally binding if set to true. Defaults to false.