Create sign request from a template

post https://api.docmadeeasy.com/rest/envelope/create/{templateId}

time	status	user agent
Retrieving recent requests…

Loading…

Creates and sends a new sign request from a template.

JSFiddle Playground

Path Params

templateId

string

required

ID of template. You can find it on admin page:

Body Params

recipients

array of objects

required

The list of recipients you're sending the document to. The ID or email are required. If the ID is passed, an existing recipient will be updated. If the email is passed, a new recipient will be added to CC.

recipients*

file

A PDF file to be used to replace the template document. Make sure the PDF file has the same number of pages as the document in template.

testMode

boolean

required

Defaults to false

If it's in test mode

allowReassign

boolean

Defaults to true

Allows signers to reassign their signature requests to other signers if set to true.

allowDecline

boolean

Defaults to true

Allows signers to decline to sign a document if true.

redirectUrl

url

Redirect URL after signer finishes signing.

deliverEmail

boolean

required

Defaults to true

True by default, so email notifications will be sent by our servers. If false, no email will be sent and you are responsible for sending out email notifications.

linkExpire

string

required

Defaults to 5

Link expire time, in minutes.

message

blob

required

Defaults to Hello {{recipient_name}}, {{sender_name}} has sent you a new document to view and sign. Please click on the link to begin signing.

( <= 5000 characters ) Body of the email.

subject

string

required

Defaults to Please sign the document.

( <= 255 characters ) Subject of the email.

Responses

Response body

object

int64

required

success

boolean

required

recipients

array of objects

recipients

object

name

string

order

string

A number starting from 1. Without signing order, value is always 1.
Signing order is used to ask recipients to sign in this order (ascending) from lower to higher. If there are multiple recipients with the same signing order, all of them get it at the same time.

select

string

code

string

Access code

state

integer

Value	Description
-1	Declined
0	Created
100	Signed

-1 100

updateTime

int64

Update time, in milliseconds elapsed since the UNIX epoch (Jan 1, 1970).

url

string

URL of document without expiry time.

urlWithExpiry

string

URL of document that will expire if expiry time is specified in the request.

downloadSignedPdf

string

URL for downloading signed PDF document of this recipient. Only available if it's a bulk send.

downloadAuditPdf

string

URL for downloading audit trail document of this recipient. Only available if it's a bulk send.

JSFiddle Playground

200successful operation

400Invalid request