API version:
POST /public/v2/reusable_templates/:id/prepare_document
Prepare a document to be sent from a Reusable Template
Supported Formats
jsonErrors
Code | Description |
---|---|
400 | invalid_scope |
400 | unauthorized_client |
401 | Can't find Reusable Template. |
401 | Unauthorized account for Reusable Template. |
422 | The role name supplied (<NAME>) does not match the role name expected. |
Params
Param name | Description |
---|---|
name optional |
A name for the document you are sending Validations:
|
shared_with optional |
List of email recipients to share the document with Validations:
|
message optional |
A message for all signers Validations:
|
redirect_url optional |
A URL to redirect to after sending the document. Must start with http:// or https://. Example: example.com/redirect Validations:
|
callback_url optional |
Document callback url. The URL will receive a POST for each of the following document events: ex. callback when document is viewed { "callbackType":"Document", "id":"edc7823a-7b99-45d7-9c3c-c7dc81f8dbf2", "event":"viewed", "documentState":"pending", "createdAt":"2016-11-14T13:45:23.199-08:00" } Validations:
|
roles required |
Document signers Validations:
|
roles[name] required |
Role name. For text tags, the role name in the request must correspond to the recipient name given as the second argument (name) in the text tag. When signer sequencing is enabled, the role name must match the signer name set on the template. Validations:
|
roles[signer_name] optional |
Signer name Validations:
|
roles[signer_email] optional |
Signer email Validations:
|
roles[signer_omitted] optional |
A signer can be omitted if set to true and if signer_sequencing is enabled Validations:
|
roles[is_sender] optional |
Is signer the owner of document? Validations:
|
roles[message] optional |
Custom message to signer. Validations:
|
expires_in required |
Document expiration. Must be between 1 and 365 days |
pin optional |
Document pin. Must be between 10000 and 99999 |
tags optional |
Optional key value tags for categorization |