Gets the BCC email archive configurations for an account
This method retrieves all of the BCC email archive configurations associated with an account.
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
Query Parameters
The maximum number of results to return.
Use start_position to specify the number of results to skip.
The zero-based index of the result from which to start returning results.
Use with count to limit the number
of results.
The default value is 0.
Response Body
application/json
application/json
curl -X GET "https://example.com/v2.1/accounts/string/settings/bcc_email_archives"{ "bccEmailArchives": [ { "accountId": "string", "bccEmailArchiveId": "string", "created": "string", "createdBy": { "accountId": "string", "accountName": "string", "activationAccessCode": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "ipAddress": "string", "loginStatus": "string", "membershipId": "string", "sendActivationEmail": "string", "uri": "string", "userId": "string", "userName": "string", "userStatus": "string", "userType": "string" }, "email": "string", "emailNotificationId": "string", "modified": "string", "modifiedBy": { "accountId": "string", "accountName": "string", "activationAccessCode": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "ipAddress": "string", "loginStatus": "string", "membershipId": "string", "sendActivationEmail": "string", "uri": "string", "userId": "string", "userName": "string", "userStatus": "string", "userType": "string" }, "status": "string", "uri": "string" } ], "endPosition": "string", "nextUri": "string", "previousUri": "string", "resultSetSize": "string", "startPosition": "string", "totalSetSize": "string"}Creates a bulk send test POST
This method tests a bulk send list for compatibility with the envelope or template that you want to send. For example, a template that has three roles is not compatible with a bulk send list that has only two recipients. For this reason, you might want to test compatibility first. A successful test result returns `true` for the `canBeSent` property. An unsuccessful test returns a JSON response that contains information about the errors that occurred. If the test is successful, you can then send the envelope or template by using the [BulkSend::createBulkSendRequest][BulkSendRequest] method. ## Envelope Compatibility Checks This section describes the envelope compatibility checks that the system performs. **Top-Level Issues** - Envelopes must be in a sendable state. - The bulk send list must contain at least one copy (instance of an envelope), and no more than the maximum number of copies allowed for the account. - The envelope must not be null and must be visible to the current user. - The account cannot have more queued envelopes than the maximum number configured for the account. - The bulk send list must exist. **Recipients** - The envelope must have recipients. - If you are using an envelope, all of the recipients defined in the bulk send list must have corresponding recipient IDs in the envelope definition. If you are using a template, you must either match the recipient IDs or role IDs. - The envelope cannot contain a bulk recipient (an artifact of the legacy version of Docusign's bulk send functionality). **Recipient Tabs** - Every `recipient ID, tab label` pair in the bulk send list must correspond to a tab in the envelope. **Custom Fields** - Each envelope-level custom field in the bulk send list must correspond to the name of a `customField` in the envelope definition. You do not have to match the recipient-level custom fields. [BulkSendRequest]: https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendrequest/
Creates a BCC email archive configuration POST
This method creates a BCC email archive configuration for an account (adds a BCC email address to the account for archiving the emails that Docusign generates). The only property that you must set in the request body is the BCC email address that you want to use. **Note:** An account can have up to five active and pending email archive addresses combined, but you must use this method to add them to the account one at a time. Each email address is considered a separate BCC email archive configuration.