B C C Email Archive

Gets a BCC email archive configuration and its history

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

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

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.

bccEmailArchiveId*string

The ID of the BCC email archive configuration.

Query Parameters

count?string

The maximum number of results to return.

Use start_position to specify the number of items to skip.

start_position?string

The zero-based index of the result from which to start returning results.

Use with count to limit the number of results.

The default value is 0.

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/settings/bcc_email_archives/string"
{  "bccEmailArchiveHistory": [    {      "accountId": "string",      "action": "string",      "email": "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"    }  ],  "endPosition": "string",  "nextUri": "string",  "previousUri": "string",  "resultSetSize": "string",  "startPosition": "string",  "totalSetSize": "string"}