Updates document visibility for a template recipient
This method updates the document visibility for a template recipient.
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 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
A local reference used to map recipients to other objects, such as specific document tabs.
A recipientId must be
either an integer or a GUID,
and the recipientId must be
unique within an envelope.
For example, many envelopes assign the first recipient
a recipientId of 1.
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.
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/string/document_visibility" \ -H "Content-Type: application/json" \ -d '{}'{ "documentVisibility": [ { "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "recipientId": "string", "rights": "string", "visible": "string" } ]}Returns document visibility for a template recipient GET
This method returns information about document visibility for a template recipient.
Updates document visibility for template recipients PUT
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.