Skip to content

Latest commit

 

History

History
40 lines (35 loc) · 6.34 KB

UnclaimedDraftCreateEmbeddedWithTemplateRequest.md

File metadata and controls

40 lines (35 loc) · 6.34 KB
Raw

# UnclaimedDraftCreateEmbeddedWithTemplateRequest

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.
templateIds*required Array<string> Use template_ids to create a SignatureRequest from one or more templates, in the order in which the templates will be used.
allowDecline boolean Allows signers to decline to sign a document if true. Defaults to false. [default 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.		 [default to false]
ccs Array<SubCC> Add CC email recipients. Required when a CC role exists for the Template.
customFields Array<SubCustomField> An array defining values and options for custom fields. Required when a custom field exists in the Template.
editorOptions SubEditorOptions
fieldOptions SubFieldOptions
files Array<RequestFile> 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.
fileUrls Array<string> 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.
forceSignerRoles boolean Provide users the ability to review/edit the template signer roles. [default to false]
forceSubjectMessage boolean Provide users the ability to review/edit the template subject and message. [default to false]
holdRequest boolean 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. [default to false]
isForEmbeddedSigning boolean The request created from this draft will also be signable in embedded mode if set to true. Defaults to false. [default to false]
message string The custom message in the email that will be sent to the signers.
metadata { [key: string]: any; } 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.
previewOnly boolean 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&#x3D;true: Allows requesters to enable the preview only experience. - preview_only&#x3D;false: Allows requesters to disable the preview only experience.

NOTE: This parameter overwrites show_preview&#x3D;1 (if set).		 [default to false]
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.		 [default to false]
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. [default to true]
signers Array<SubUnclaimedDraftTemplateSigner> Add Signers to your Templated-based 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. [default 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. [default to false]
title string The title you want to assign to the SignatureRequest.
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.		 [default to false]
allowCcs boolean This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. [default to false]

[Back to Model list] [Back to API list] [Back to README]