Skip to content

Latest commit

 

History

History
58 lines (45 loc) · 9.26 KB

UnclaimedDraftCreateEmbeddedRequest.md

File metadata and controls

58 lines (45 loc) · 9.26 KB
Raw

UnclaimedDraftCreateEmbeddedRequest

Properties

Name Type Description Notes
clientId*required String Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
requesterEmailAddress*required String The email address of the user that should be designated as the requester of this draft, if the draft type is request_signature.
files List<File> Use files[] to indicate the uploaded file(s) to send for signature.

This endpoint requires either files or file_urls[], but not both.
fileUrls List<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.
allowCcs Boolean This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.
allowDecline Boolean Allows signers to decline to sign a document if true. Defaults to false.
allowReassign Boolean 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.
attachments List<SubAttachment> A list describing the attachments
ccEmailAddresses List<String> The email addresses that should be CCed.
customFields List<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.
editorOptions SubEditorOptions
fieldOptions SubFieldOptions
forceSignerPage Boolean Provide users the ability to review/edit the signers.
forceSubjectMessage Boolean Provide users the ability to review/edit the subject and message.
formFieldGroups List<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.
formFieldRules List<SubFormFieldRule> Conditional Logic rules for fields defined in form_fields_per_document.
formFieldsPerDocument List<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
hideTextTags 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.
holdRequest Boolean 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.
isForEmbeddedSigning Boolean The request created from this draft will also be signable in embedded mode if set to true. Defaults to false.
message String The custom message in the email that will be sent to the signers.
metadata Map<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.
requestingRedirectUrl String The URL you want signers redirected to after they successfully request a signature.
showPreview Boolean This allows the requester to enable the editor/preview experience.

- show_preview&#x3D;true: Allows requesters to enable the editor/preview experience. - show_preview&#x3D;false: Allows requesters to disable the editor/preview experience.
showProgressStepper 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.
signers List<SubUnclaimedDraftSigner> Add Signers to your Unclaimed Draft Signature Request.
signingOptions SubSigningOptions
signingRedirectUrl String The URL you want signers redirected to after they successfully sign.
skipMeNow Boolean Disables the "Me (Now)" option for the person preparing the document. Does not work with type send_document. Defaults to false.
subject String The subject in the email that will be sent to the signers.
testMode 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.
type TypeEnum 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.
usePreexistingFields 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.
useTextTags 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.
populateAutoFillFields Boolean 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.
expiresAt 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.

Enum: TypeEnum

Name Value
SEND_DOCUMENT "send_document"
REQUEST_SIGNATURE "request_signature"