---
title: "Updates document visibility for recipients"
method: PUT
path: "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility"
tags: ["EnvelopeDocumentVisibility"]
---

# Updates document visibility for recipients

`PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility`

## Request

- Base URL: `https://www.docusign.net/restapi`
- URL: `https://www.docusign.net/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility`
- Auth: none declared

This method updates document visibility for one or more 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.

## Path parameters

- `accountId` string, required
- `envelopeId` string, required

## Request body

- DocumentVisibilityList: A list of `documentVisibility` objects that specify whether documents are visible to recipients.
  - `documentVisibility` DocumentVisibility[]: An array of `documentVisibility` objects that specifies which documents are visible to which recipients.
    - `documentId` string: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
    - `errorDetails` ErrorDetails: This object describes errors that occur. It is only valid for responses and ignored in requests.
      - `errorCode` string: The code associated with the error condition.
      - `message` string: A brief message describing the error condition.
    - `recipientId` string: The ID of the recipient to whom the document visibility setting is applied. This value should match the `recipientId` defined in the recipient object.
    - `rights` string: Indicates whether the document is editable: - `editable` - `read_only`
    - `visible` string: When **true,** the document is visible to the recipient.

## Response `200`

Successful response.

## Other responses

- `400`: Error encountered.

## Changes

- **2021-08-30** (v2) `0b7512add92a`: 2 info
  - api tag `EnvelopeDocumentVisibility` added
  - api tag `EnvelopeRecipients` removed
- **2021-03-19** (v2) `3082af8bcaf7`: 2 info
  - api tag `EnvelopeRecipients` added
  - api tag `EnvelopeDocumentVisibility` removed

[Operation history](https://skmtc.dev/docusign/apis/docusign-esignature-rest-api/changes/v2.1/accounts/:accountId/envelopes/:envelopeId/recipients/document_visibility/put.md)

---

[API](https://skmtc.dev/docusign/apis/docusign-esignature-rest-api.md) - [All operations](https://skmtc.dev/docusign/apis/docusign-esignature-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/docusign/apis/docusign-esignature-rest-api/revisions/77f1998c313d?raw)