TemplateDocumentVisibility

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.

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

Request

  • Base URL
    https://www.docusign.net/restapi
  • URL
    https://www.docusign.net/restapi/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility
  • Auth
    none declared

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

recipientIdstring required

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.

templateIdstring required

The ID of the template.

Request body

Response

Successful response.

Changes

No recorded changes to this operation across all 39 revisions of this API.