Update document visibility for recipient

PUT

/v2.1/accounts/:accountId/envelopes/:envelopeId/recipients/:recipientId/document_visibility

PUT

/restapi/v2.1/accounts/:accountId/envelopes/:envelopeId/recipients/:recipientId/document_visibility

curl -X PUT https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/envelopes/ENVELOPE_ID/recipients/RECIPIENT_ID/document_visibility \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "documentVisibility": [
    {
      "documentId": "sample string 1",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      },
      "recipientId": "sample string 2",
      "rights": "sample string 3",
      "visible": "sample string 4"
    }
  ]
}'

{
  "documentVisibility": [
    {
      "documentId": "sample string 1",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      },
      "recipientId": "sample string 2",
      "rights": "sample string 3",
      "visible": "sample string 4"
    }
  ]
}

This method updates document visibility for a 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.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

envelopeIdstringRequired

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

recipientIdstringRequired

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.

Request

This endpoint expects an object: documentVisibilityList

documentVisibilitylist of objectsOptional

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

Response

Successful response.

documentVisibilitylist of objectsOptional

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

Errors

400

Bad Request Error