EnvelopeTemplates::applyTemplateToDocument method

Adds templates to a document in the specified envelope.

Request

HTTP request

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

Parameters

Parameter Name	Value	Description
Path Parameters
accountId	string	The external account number (int) or account ID GUID.
documentId	string	The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include 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`
Optional Query Parameters
preserve_template_recipient	string

Code	Description	Reference
201	Successful response.	documentTemplateList
400	Error encountered.	errorDetails

Code

Description

Reference

201

Successful response.

documentTemplateList

400

Error encountered.

errorDetails

Definitions

documentTemplate


`documentEndPage`	string
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentStartPage`	string
`errorDetails`	errorDetails	This object describes errors that occur. It is only valid for responses and ignored in requests.
`templateId`	string	The unique identifier of the template. If this is not provided, DocuSign generates an error and the call fails.

documentTemplateList


`documentTemplates`	[documentTemplate]

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCode

string

The code associated with the error condition.

message

string

A brief message describing the error condition.

Examples

Generic JSON Request/Response

Request

{
  "documentTemplates": [
    {
      "documentId": "sample string 1",
      "templateId": "sample string 2",
      "documentStartPage": "sample string 3",
      "documentEndPage": "sample string 4"
    }
  ]
}

Response

{
  "documentTemplates": [
    {
      "documentId": "sample string 1",
      "templateId": "sample string 2",
      "documentStartPage": "sample string 3",
      "documentEndPage": "sample string 4",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      }
    }
  ]
}

Generic XML Request/Response

Request

<documentTemplates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <documentTemplates>
    <documentTemplate>
      <documentEndPage>sample string 4</documentEndPage>
      <documentId>sample string 1</documentId>
      <documentStartPage>sample string 3</documentStartPage>
      <templateId>sample string 2</templateId>
    </documentTemplate>
  </documentTemplates>
</documentTemplates>

Response

<documentTemplates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <documentTemplates>
    <documentTemplate>
      <documentEndPage>sample string 4</documentEndPage>
      <documentId>sample string 1</documentId>
      <documentStartPage>sample string 3</documentStartPage>
      <errorDetails>
        <errorCode>sample string 1</errorCode>
        <message>sample string 2</message>
      </errorDetails>
      <templateId>sample string 2</templateId>
    </documentTemplate>
  </documentTemplates>
</documentTemplates>

EnvelopeTemplates: applyToDocument

Request

HTTP request

Parameters

Request Body

Responses

SDK Method

Definitions

Examples