Envelope Templates

Gets the templates associated with a document in an existing envelope

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

Retrieves the templates associated with a document in the specified envelope.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

documentId*string

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.

envelopeId*string

The envelope's GUID.

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

Query Parameters

include?string

A comma-separated list that limits the results. Valid values are:

  • applied
  • matched

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/envelopes/string/documents/string/templates"
{  "templates": [    {      "applied": "string",      "documentId": "string",      "documentName": "string",      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "name": "string",      "templateId": "string",      "templateMatch": {        "documentEndPage": "string",        "documentStartPage": "string",        "matchPercentage": "string"      },      "uri": "string"    }  ]}

Gets envelope statuses for a set of envelopes PUT

Retrieves envelope statuses for a set of envelopes. `Envelopes: listStatus` has both a `GET` and a `PUT` implementation: * `PUT /restapi/v2.1/accounts/{accountId}/envelopes/status` is passed a set of envelope IDs in the request body. This version of the method returns a smaller subset of envelope information. * `GET /restapi/v2.1/accounts/{accountId}/envelopes/status` is passed a list of envelope IDs in a query string. <ds-inlinemessage> To search for envelopes using a broad range of filters, use <a href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/">Envelopes: listStatusChanges</a> instead of this method. </ds-inlinemessage> You must specify exactly one of the following query parameters: | Parameter | Description | | :---------------- | :------------------------------------------------------------------------------- | | `from_date` | a valid UTC DateTime: `2016-01-01` | | `envelope_ids` | <ul><li>For the <code>GET</code> implementation of this method, include the envelope IDs in a comma-separated list. </li><li>For the <code>PUT</code> version of this method, you should use the <code>request_body</code> value for this parameter and include the list of envelope IDs in the request body.</li></ul> | | `transaction_ids` | A comma-separated list of transaction IDs<br>or the special value <code>request_body</code> | When you use the special value `request_body`, the request body looks like this: ``` { "envelopeIds": [ "44c5ad6c-xxxx-xxxx-xxxx-ebda5e2dfe15", "8e26040d-xxxx-xxxx-xxxx-1e29b924d237", "c8b40a2d-xxxx-xxxx-xxxx-4fe56fe10f95" ] } ``` <ds-inlinemessage kind="warning"> Omitting the request body altogether causes the endpoint to return an error. The request body must be at least <code>{}</code>. </ds-inlinemessage> ### Related topics - [Searching for envelopes](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/envelopes/search/) - [How to list envelope status changes](https://developers.docusign.com/docs/esign-rest-api/how-to/list-envelope-status-changes/)

Adds templates to a document in an envelope POST

Adds templates to a document in the specified envelope.