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

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Optional Query Parameters
countstring

(Optional) The maximum number of results to return.

start_positionstring

(Optional) The index position within the total result set from which to start returning values. The default value is 0.

Responses

CodeDescriptionReference
200

Successful response.

bccEmailArchiveList
400

Error encountered.

errorDetails

SDK Method

EmailArchive::list

Definitions

bccEmailArchive

This object contains information abut a BCC email archive configuration (a BCC email address used to archive DocuSign-generated emails).

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.

createdByuserInfo

Details about the user who created the BCC email archive configuration.

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.

modifiedByuserInfo

Details about the user who last modified the BCC email archive configuration.

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.

bccEmailArchiveList

Contains a list of BCC email archive configurations.

bccEmailArchives[bccEmailArchive]

A list of BCC email archive configurations.

endPositionstring

The last index position in the result set.

nextUristring

The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.

previousUristring

The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.

resultSetSizestring

The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the totalSetSize.

startPositionstring

The starting index position of the current result set.

totalSetSizestring

The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

userInfo

accountIdstring

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

accountNamestring

The name of the account associated with the current workspace user.

activationAccessCodestring

Access code provided to the user to activate the account.

emailstring

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

loginStatusstring

Boolean value that indicates whether the user is currently logged in or not.

membershipIdstring

The user's membership ID.

sendActivationEmailstring

When set to true, specifies that an activation email be sent to the user.

uristring

A URI containing the user ID.

userIdstring

The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, userId can represent another user whom the Administrator is accessing.

userNamestring

The name of the user.

userStatusstring

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

userTypestring

The type of user, for example CompanyUser.

}} />