Skip to content

Latest commit

 

History

History
33 lines (28 loc) · 7.04 KB

UnclaimedDraftCreateRequest.md

File metadata and controls

33 lines (28 loc) · 7.04 KB
Raw

Dropbox::Sign::UnclaimedDraftCreateRequest

Properties

Name Type Description Notes
type*required String 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.
files Array<File> Use files[] to indicate the uploaded file(s) to send for signature.

This endpoint requires either files or file_urls[], but not both.
file_urls Array<String> 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.
allow_decline Boolean Allows signers to decline to sign a document if true. Defaults to false. [default to false]
attachments Array<SubAttachment> A list describing the attachments
cc_email_addresses Array<String> The email addresses that should be CCed.
client_id String Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
custom_fields Array<SubCustomField> 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.
field_options SubFieldOptions
form_field_groups Array<SubFormFieldGroup> 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_rules Array<SubFormFieldRule> Conditional Logic rules for fields defined in form_fields_per_document.
form_fields_per_document Array<SubFormFieldsPerDocumentBase> 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_tags Boolean 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. [default to false]
message String The custom message in the email that will be sent to the signers.
metadata Hash<String, Object> 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_stepper Boolean When only one step remains in the signature request process and this parameter is set to false then the progress stepper will be hidden. [default to true]
signers Array<SubUnclaimedDraftSigner> Add Signers to your Unclaimed Draft Signature Request.
signing_options SubSigningOptions
signing_redirect_url String The URL you want signers redirected to after they successfully sign.
subject String The subject in the email that will be sent to the signers.
test_mode Boolean Whether this is a test, the signature request created from this draft will not be legally binding if set to true. Defaults to false. [default to false]
use_preexisting_fields Boolean 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. [default to false]
use_text_tags Boolean 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. [default to false]
expires_at Integer 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.