Request

HTTP request

PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility

Parameters

Parameter name Value Description
Path parameters
accountId string

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

envelopeId string

The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

recipientId string

The recipientId used when the envelope or template was created.

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Envelopes::updateRecipientDocumentVisibility

Definitions Expand All | Collapse All

EnvelopeDocumentVisibility

documentVisibility
[documentVisibility]

documentVisibility

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
recipientId string

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

rights string
visible string

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode string

An error code associated with the error.

message string

A short error message.

Examples

Generic JSON Request/Response

Request

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

Response

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

Generic XML Request/Response

Request

<documentVisibilityList 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<documentVisibility>
<documentVisibility>
<documentId>sample string 2</documentId>
<recipientId>sample string 1</recipientId>
<rights>sample string 4</rights>
<visible>sample string 3</visible>
</documentVisibility>
</documentVisibility>
</documentVisibilityList>

Response

<documentVisibilityList 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<documentVisibility>
<documentVisibility>
<documentId>sample string 2</documentId>
<errorDetails>
<errorCode>sample string 1</errorCode>
<message>sample string 2</message>
</errorDetails>
<recipientId>sample string 1</recipientId>
<rights>sample string 4</rights>
<visible>sample string 3</visible>
</documentVisibility>
</documentVisibility>
</documentVisibilityList>