SendListRecipients
This method returns all of the details of recipents associated with a specific bulk send list that belongs to the current user.
View Specific Information
The driver will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the driver.
- BulkSendListId supports the '='.
For example, the following queries are processed server side:
SELECT * FROM SendListRecipients SELECT * FROM SendListRecipients WHERE BulkSendListId = 'asd-wdas-dw'
Columns
| Name | Type | References | Description |
| BulkSendListId | String |
SendLists.BulkSendListId | The GUID of the bulk send list. |
| RecipientId | String | Unique Id for the recipient. | |
| String | Specifies the recipient's email address. | ||
| Name | String | Specifies the recipient's name. | |
| ClientUserId | String | Specifies whether the recipient is embedded or remote. | |
| CustomFields | String | An optional array of strings that allows the sender to provide custom data about the recipient. | |
| DeliveryMethod | String | The delivery method. | |
| EmailNotification | String | This optional property allows you to set a specific email subject and body for this recipient's notification email. | |
| EmbeddedRecipientStartURL | String | Specifies a sender-provided valid URL string for redirecting an embedded recipient. | |
| HostEmail | String | The email address of the signing host. | |
| HostName | String | The name of the signing host. | |
| IdCheckConfigurationName | String | The name of the authentication check to use. | |
| IdCheckInformationInput | String | An object that contains input information related to a recipient ID check. | |
| IdentificationMethod | String | Identification Method. | |
| IdentityVerification | String | Specifies the ID Verification workflow applied on an envelope by workflow ID. | |
| PhoneAuthentication | String | When idCheckConfigurationName is set to Phone Auth \$, you use this complex type to provide the recipient authentication method details. | |
| RecipientSignatureProviders | String | The default signature provider is the DocuSign Electronic signature system. | |
| RoleName | String | The name of the role associated with the recipient. | |
| Note | String | A note sent to the recipient in the signing email. This note is unique to this recipient. | |
| SignerName | String | The in-person signer's full legal name. | |
| SigningGroupId | String | The ID of the signing group. | |
| AccessCode | String | If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. | |
| PhoneNumber | String | This is only used if the Identification field value is Phone or SMS. | |
| SMSAuthentication | String | When idCheckConfigurationName is set to SMS Auth \$, you use this complex type to provide the recipient authentication method details. | |
| Tabs | String | A list of tabs associated with the recipient. |