Create BCC email archive configuration | Docusign

curl -X POST https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/settings/bcc_email_archives \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "bccEmailArchiveId": "sample string 2",
  "created": "sample string 3",
  "createdBy": {
    "accountId": "sample string 1",
    "accountName": "sample string 2",
    "activationAccessCode": "sample string 3",
    "email": "sample string 4",
    "errorDetails": {
      "errorCode": "sample string 1",
      "message": "sample string 2"
    },
    "ipAddress": "sample string 5",
    "loginStatus": "sample string 6",
    "membershipId": "sample string 7",
    "sendActivationEmail": "sample string 8",
    "uri": "sample string 9",
    "userId": "sample string 10",
    "userName": "sample string 11",
    "userStatus": "sample string 12",
    "userType": "sample string 13"
  },
  "email": "sample string 4",
  "emailNotificationId": "sample string 5",
  "modified": "sample string 6",
  "status": "sample string 7",
  "uri": "sample string 8"
}'

{
  "accountId": "sample string 1",
  "bccEmailArchiveId": "sample string 2",
  "created": "sample string 3",
  "createdBy": {
    "accountId": "sample string 1",
    "accountName": "sample string 2",
    "activationAccessCode": "sample string 3",
    "email": "sample string 4",
    "errorDetails": {
      "errorCode": "sample string 1",
      "message": "sample string 2"
    },
    "ipAddress": "sample string 5",
    "loginStatus": "sample string 6",
    "membershipId": "sample string 7",
    "sendActivationEmail": "sample string 8",
    "uri": "sample string 9",
    "userId": "sample string 10",
    "userName": "sample string 11",
    "userStatus": "sample string 12",
    "userType": "sample string 13"
  },
  "email": "sample string 4",
  "emailNotificationId": "sample string 5",
  "modified": "sample string 6",
  "status": "sample string 7",
  "uri": "sample string 8"
}

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.

See Email Archive Configuration for details and restrictions on creating or changing BCC email addresses.

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.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

Request

This endpoint expects an object: bccEmailArchive

accountIdstringOptional

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

bccEmailArchiveIdstringOptional

The ID of the BCC email archive configuration.

createdstringOptional

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

createdByobjectOptional

emailstringOptional

The BCC email address to use for archiving Docusign messages.

Example: customer_bcc@example.com

emailNotificationIdstringOptional

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

modifiedstringOptional

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

modifiedByobjectOptional

statusstringOptional

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.

uristringOptional

The helper URI for retrieving the BCC email archive.

Response

Successful response.