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

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

bccEmailArchiveIdstring

The id of the BCC email archive configuration.

Optional Query Parameters
countstring

(Optional) The maximum number of results (changes) 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.

BCCEmailArchive
400

Error encountered.

errorDetails

SDK Method

EmailArchive::get

Definitions

bccEmailArchiveHistory

Contains details about the history of the BCC email archive configuration.

accountIdstring

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

actionstring

The action taken on the BCC email archive configuration.

Examples:

  • CREATED: The BCC email archive configuration has been created.
  • UPDATED: The BCC email address has been activated by clicking on the activation link in the activation email message.
  • CLOSED: The BCC email address has been marked as closed is no longer used for archiving.

emailstring

The BCC email address used to archive the emails that DocuSign generates.

Example: customer_bcc@example.com

modifiedstring

The UTC DateTime when the BCC email address 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.

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.

BCCEmailArchive

The EmailArchive resource provides methods for managing your email archive configuration, which consists of the BCC email address or addresses that you want to use to archive DocuSign emails. Each account can use up to five BCC email addresses for archiving purposes.

bccEmailArchiveHistory[bccEmailArchiveHistory]

A list of changes to the BCC email archive configuration.

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.

}} />