Skip to content

Latest commit

 

History

History
34 lines (29 loc) · 5.79 KB

TemplateCreateEmbeddedDraftRequest.md

File metadata and controls

34 lines (29 loc) · 5.79 KB
Raw

Dropbox::Sign::TemplateCreateEmbeddedDraftRequest

Properties

Name Type Description Notes
client_id*required String Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app.
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_ccs Boolean This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. [default to true]
allow_reassign 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]
attachments Array<SubAttachment> A list describing the attachments
cc_roles Array<String> The CC roles that must be assigned when using the template to send a signature request
editor_options SubEditorOptions
field_options SubFieldOptions
force_signer_roles Boolean Provide users the ability to review/edit the template signer roles. [default to false]
force_subject_message Boolean Provide users the ability to review/edit the template subject and message. [default to false]
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
merge_fields Array<SubMergeField> 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.
message String The default template email message.
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_preview 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]
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]
signer_roles Array<SubTemplateRole> An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
skip_me_now 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 template title (alias).
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]
title String The title you want to assign to the SignatureRequest.
use_preexisting_fields Boolean Enable the detection of predefined PDF fields by setting the use_preexisting_fields to true (defaults to disabled, or false). [default to false]