Template Documents

Deletes documents from a template

DELETE
/v2.1/accounts/{accountId}/templates/{templateId}/documents

This method deletes one or more documents from an existing template.

To delete a document, use only the relevant parts of the envelopeDefinition. For example, this request body specifies that you want to delete the document whose documentId is "1".

{  "documents": [    {      "documentId": "1"    }  ]}

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.

templateId*string

The ID of the template.

Response Body

application/json

application/json

curl -X DELETE "https://example.com/v2.1/accounts/string/templates/string/documents"
{  "templateDocuments": [    {      "addedRecipientIds": [        "string"      ],      "agreementType": "string",      "agreementTypeSource": "string",      "attachmentTabId": "string",      "authoritativeCopy": "string",      "availableDocumentTypes": [        {          "isDefault": "string",          "type": "string"        }      ],      "containsPdfFormFields": "string",      "display": "string",      "docGenDocumentStatus": "string",      "docGenErrors": [        {          "errorCode": "string",          "message": "string",          "tagIdentifier": "string"        }      ],      "docGenFormFields": [        {          "connectedObjectDetails": {            "recordId": "string"          },          "defaultValue": "string",          "description": "string",          "filter": "string",          "format": {            "expression": "string",            "locale": "string"          },          "fullyQualifiedPath": "string",          "hidden": "string",          "label": "string",          "name": "string",          "options": [            {              "description": "string",              "label": "string",              "selected": "string",              "value": "string"            }          ],          "order": "string",          "predefinedValidation": "string",          "readOnly": "string",          "required": "string",          "rowValues": [            {              "docGenFormFieldList": [                {}              ]            }          ],          "type": "string",          "validation": {            "errorMessage": "string",            "expression": "string"          },          "value": "string"        }      ],      "documentBase64": "string",      "documentFields": [        {          "errorDetails": {            "errorCode": "string",            "message": "string"          },          "name": "string",          "originalValue": "string",          "value": "string"        }      ],      "documentId": "string",      "documentIdGuid": "string",      "documentTemplateId": "string",      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "hasDigitalSignature": "string",      "includeInDownload": "string",      "isAceGenDocument": "string",      "isDocGenDocument": "string",      "isEdited": "string",      "isExternallyAvailable": "string",      "isFlattened": "string",      "name": "string",      "order": "string",      "pages": [        {          "dpi": "string",          "errorDetails": {            "errorCode": "string",            "message": "string"          },          "height": "string",          "imageBytes": "string",          "mimeType": "string",          "pageId": "string",          "sequence": "string",          "width": "string"        }      ],      "signerMustAcknowledge": "string",      "sizeBytes": "string",      "templateLocked": "string",      "templateRequired": "string",      "type": "string",      "uri": "string"    }  ],  "templateId": "string"}