Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
B C C Email Archive

Creates a BCC email archive configuration

POST
/v2.1/accounts/{accountId}/settings/bcc_email_archives

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.

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.

Request Body

application/json

Boolean that specifies whether BCC for Email Archive is enabled for the account. BCC for Email Archive allows you to set up an archive email address so that a BCC copy of an envelope is sent only to that address.

Boolean that specifies whether BCC for Email Archive is enabled for the account. BCC for Email Archive allows you to set up an archive email address so that a BCC copy of an envelope is sent only to that address.

accountId?string

The ID of the account that owns the BCC email archive configuration.

bccEmailArchiveId?string

The ID of the BCC email archive configuration.

created?string

The UTC DateTime when the BCC email archive configuration was created.

createdBy?
email?string

The BCC email address to use for archiving Docusign messages.

Example: customer_bcc@example.com

emailNotificationId?string

The GUID of the activation email message sent to the BCC email address.

modified?string

The UTC DateTime when the BCC email archive configuration was last modified.

modifiedBy?
status?string

The status of the BCC email address. Possible values are:

  • activation_sent: An activation link has been sent to the BCC email address.
  • active: The BCC email address is actively used for archiving.
  • closed: The BCC email address is no longer used for archiving.
uri?string

The helper URI for retrieving the BCC email archive.

Response Body

application/json

application/json

curl -X POST "https://example.com/v2.1/accounts/string/settings/bcc_email_archives" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"}

Gets the BCC email archive configurations for an account GET

This method retrieves all of the BCC email archive configurations associated with an account.

Gets a BCC email archive configuration and its history GET

This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.