v1

latestSwagger 2.02026-07-134146194.6 MB

EnvelopeTemplates

Adds templates to a document in an envelope.

Adds templates to a document in the specified envelope.

post/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

documentIdstring required

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647).

Tab objects have a documentId property that specifies the document on which to place the tab.

envelopeIdstring required

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Query parameters

preserve_template_recipientstring

If omitted or set to false (the default), envelope recipients will be removed if the template being applied includes only tabs positioned via anchor text for the recipient, and none of the documents include the anchor text.

When true, the recipients will be preserved after the template is applied.

Request body

Response

Successful response.