DocumentVisibility
The Document Visibility resource provides methods that manage document views and insights in an envelope or template.
View Specific Information
In order to make a successful request on this view, you have to specify:
- Type - Possible options are envelopes or templates.
- Id - Id of the envelope or template.
- RecipientId - Id of the recipient.
For example:
SELECT * FROM DocumentVisibility WHERE Type = 'envelopes' AND Id = '764c564c-b540-42d1-a667-ccee6813ef7b' AND RecipientId = 77419544 SELECT * FROM DocumentVisibility WHERE Type = 'templates' AND Id = 'd194aa0a-723e-4db9-a8be-801dffbb63ff' AND RecipientId = 75619544
Columns
Name | Type | References | Description |
Id [KEY] | String | Id of the Envelope or Template. | |
Type | String | Specifies where the tab is applied. Possible options are envelopes or templates | |
RecipientId | Integer | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. | |
DocumentId | String |
Documents.DocumentId | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |
Visible | Boolean | When set to true, the document is visible. | |
Rights | String | Rights of the recipient for this document. |