Bulk Send

Gets a specific bulk send list

GET
/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}

This method returns all of the details associated with a specific bulk send list that belongs to the current user.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

bulkSendListId*string

The GUID of the bulk send list. This property is created after you post a new bulk send list.

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/bulk_send_lists/string"
{  "bulkCopies": [    {      "customFields": [        {          "name": "string",          "value": "string"        }      ],      "docGenFormFields": [        {          "name": "string",          "rowValues": [            {              "docGenFormFieldList": [                {}              ]            }          ],          "value": "string"        }      ],      "emailBlurb": "string",      "emailSubject": "string",      "prefillTabs": [        {          "initialValue": "string",          "tabLabel": "string"        }      ],      "recipients": [        {          "accessCode": "string",          "clientUserId": "string",          "customFields": [            "string"          ],          "deliveryMethod": "string",          "email": "string",          "emailNotification": {            "emailBody": "string",            "emailSubject": "string",            "supportedLanguage": "string"          },          "embeddedRecipientStartURL": "string",          "faxNumber": "string",          "hostEmail": "string",          "hostName": "string",          "idCheckConfigurationName": "string",          "idCheckInformationInput": {            "addressInformationInput": {              "addressInformation": {                "address1": "string",                "address2": "string",                "city": "string",                "country": "string",                "fax": "string",                "phone": "string",                "postalCode": "string",                "stateOrProvince": "string",                "zipPlus4": "string"              },              "displayLevelCode": "string",              "receiveInResponse": "string"            },            "dobInformationInput": {              "dateOfBirth": "string",              "displayLevelCode": "string",              "receiveInResponse": "string"            },            "ssn4InformationInput": {              "displayLevelCode": "string",              "receiveInResponse": "string",              "ssn4": "string"            },            "ssn9InformationInput": {              "displayLevelCode": "string",              "ssn9": "string"            }          },          "identificationMethod": "string",          "identityVerification": {            "inputOptions": [              {                "name": "string",                "phoneNumberList": [                  {                    "countryCode": "string",                    "countryCodeLock": "string",                    "extension": "string",                    "number": "string"                  }                ],                "stringValue": "string",                "valueType": "string"              }            ],            "workflowId": "string",            "workflowLabel": "string"          },          "name": "string",          "note": "string",          "phoneAuthentication": {            "recipMayProvideNumber": "string",            "recordVoicePrint": "string",            "senderProvidedNumbers": [              "string"            ],            "validateRecipProvidedNumber": "string"          },          "recipientId": "string",          "recipientSignatureProviders": [            {              "sealDocumentsWithTabsOnly": "string",              "sealName": "string",              "signatureProviderName": "string",              "signatureProviderOptions": {                "cpfNumber": "string",                "oneTimePassword": "string",                "signerRole": "string",                "sms": "string"              }            }          ],          "roleName": "string",          "signerName": "string",          "signingGroupId": "string",          "smsAuthentication": {            "senderProvidedNumbers": [              "string"            ]          },          "socialAuthentications": [            {              "authentication": "string"            }          ],          "tabs": [            {              "initialValue": "string",              "tabLabel": "string"            }          ]        }      ]    }  ],  "listId": "string",  "name": "string"}

Creates a bulk send list POST

This method creates a bulk send list that you can use to send an envelope to up to 1,000 recipients at once. ### Related topics - [How to bulk send envelopes](https://developers.docusign.com/docs/esign-rest-api/how-to/bulk-send-envelopes/) ### Errors | Error code | Description | | :------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | BULK_SEND_MAX_COPIES_EXCEEDED | A bulk sending list cannot specify more than XXX copies in the mailing list. Call the settings API endpoint to find the maximum number of copies in a batch allowed for your account. In almost all cases, the default limit is 1000. | | BULK_SEND_RECIPIENT_IDS_MUST_BE_UNIQUE | No two recipientIds can be same within a bulkCopy. Same restriction as a regular envelope applies. Specify unique recipient IDs for each recipient within a bulkCopy (model for envelope in mailing list). | | BULK_SEND_RECIPIENT_ID_REQUIRED | If no RoleName is present, recipientID is required in mailing list's bulkCopy. Add a roleName (that coalesces with template/envelope) or a recipientID. | | BULK_SEND_RECIPIENT_NAME_REQUIRED | Recipient {0} has no name. Specify a name for the recipient. | | BULK_SEND_EMAIL_ADDRESS_REQUIRED_FOR_EMAIL_RECIPIENT | Recipient {0} is an email recipient with no email address. Specify an email for the email recipient. | | BULK_SEND_FAX_NUMBER_REQUIRED_FOR_FAX_RECIPIENT | Recipient {0} is a fax recipient with no fax number. Specify a fax number for the fax recipient. | | BULK_SEND_FAX_NUMBER_NOT_VALID | Recipient {0} specifies fax number {1}, which is not valid. Specify a valid fax number for the fax recipient. | | BULK_SEND_EMAIL_ADDRESS_NOT_VALID | Recipient {0} specifies email address {1}, which is not a valid email address. Specify a valid email address for the recipient. | | BULK_SEND_PHONE_NUMBER_REQURED_FOR_SMS_AUTH | Recipient {0} specifies SMS auth, but no number was provided. Specify a phone number for the SMS auth recipient. | | BULK_SEND_PHONE_NUMBER_INVALID_FOR_SMS_AUTH | Recipient {0} specifies phone number {1} for SMS auth, which is not valid. Specify a valid phone number for the SMS auth recipient. | | BULK_SEND_ROLE_NAMES_MUST_BE_UNIQUE | Recipient role names cannot be duplicated; role {duplicateRecipientRole} appears multiple times. Use unique roleNames for recipients. | | BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_ON_SAME_RECIPIENT | Recipients cannot have both ID and Role; {0} has both. Specify a roleName or recipientId, but not both for the same recipient. | | BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_IN_SAME_LIST | Cannot use both recipient role and ID in the same list. Specify a roleName or recipientId, but not both in the same list. | | BULK_SEND_INVALID_ID_CHECK_CONFIGURATION | Recipient {0} specified SMS authentication, but no SMS auth settings were provided. Provide an SMS auth setting (proper ID configuration) if SMS auth is specified. | | BULK_SEND_INVALID_SBS_INPUT_CONFIGURATION | Recipient {0} has more than one signature provider specified. Or signingProviderName is not specified. Or Signature provider : {0} is either unknown or not an available pen for this account. One or more SBS configuration is missing or invalid. The error details provide specifics. | | BULK_SEND_TAB_LABELS_MUST_BE_UNIQUE | Tab label {0} is duplicated. Needs to be unique. Use a unique tab label. | | BULK_SEND_TAB_LABEL_REQUIRED | Tab label is required. Specify a tab label. | | BULK_SEND_TAB_VALUE_REQUIRED | Tab Label value is required. Specify a value for the tab label. | | BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_MUST_BE_UNIQUE | Custom fields must have distinct names. The field {0} appears more than once in a copy. Use unique names for custom fields. | | BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_REQUIRED | All custom fields must have names. Specify a name for the custom field. | | BULK_SEND_ENVELOPE_CUSTOM_FIELD_VALUE_REQUIRED | Custom field {0} has no value. A custom field can have an empty value, but it cannot have a null value. Specify a value for the custom field. |

Deletes a bulk send list DELETE

This method deletes a bulk send list.