Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
BCCEmailArchive

Creates a BCC email archive configuration.

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.

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

Path parameters

accountIdstring required

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

Request body

accountIdstring

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

bccEmailArchiveIdstring

The ID of the BCC email archive configuration.

createdstring

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

emailstring

The BCC email address to use for archiving Docusign messages.

Example: customer_bcc@example.com

emailNotificationIdstring

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

modifiedstring

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

statusstring

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.
uristring

The helper URI for retrieving the BCC email archive.

Response

Successful response.