v1

latestSwagger 2.02026-07-134146194.6 MB
TemplateDocumentTabs

Adds tabs to a document in a template.

Adds tabs to the document specified by documentId in the template specified by templateId.

In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this:

{
  "prefillTabs": {
    "textTabs": [
      {
        "value": "a prefill text tab",
        "pageNumber": "1",
        "documentId": "1",
        "xPosition": 316,
        "yPosition": 97
      }
    ]
  }
}
post/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs

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.

templateIdstring required

The ID of the template.

Request body

Response

Successful response.