Template Document Visibility

Updates document visibility for template recipients

PUT
/v2.1/accounts/{accountId}/templates/{templateId}/recipients/document_visibility

This method updates document visibility for one or more template recipients based on the recipientId and visible values that you include in the request body.

Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.

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.

Request Body

application/json

A list of documentVisibility objects that specify whether the documents associated with a template are visible to recipients.

documentVisibility?array<>

An array of documentVisibility objects that specifies which documents are visible to which recipients.

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/templates/string/recipients/document_visibility" \  -H "Content-Type: application/json" \  -d '{}'
{  "documentVisibility": [    {      "documentId": "string",      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "recipientId": "string",      "rights": "string",      "visible": "string"    }  ]}