Get information about all archived mailings

get

https://api.campaign.episerver.net/rest/{clientId}/mailarchive

Get detailed information about all archived mailings, such as mailing type, mailingToUser ID and the date and time of creation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientId

string

required

Client ID

Query Params

from

string

Time filter to select archived mails created from date. DateTimeFormat 2021-11-07 17:43:01. UTC Timezone will be used to parse the parameter

bmMailIds

array of strings

Collection of encoded mail IDs

bmMailIds

optinStatus

string

enum

Double Opt-in status (Only for confirmation archived mails)

Allowed:

mailingId

int64

Mailing ID of archived mail

recipientId

string

Recipient ID (usually the email address)

mailingTypes

string

Collection of mailingTypes. Supported mailingTypes [event, transaction, confirmation, campaign]

recipientAddress

string

Recipient address (usually the email address)

until

string

Time filter to select archived mails created until date. DateTimeFormat 2021-11-07 17:43:01. UTC Timezone will be used to parse the parameter

Headers

next-cursor

string

Cursor to retrieve next batch. Cursor is going to expire after 10 minutes.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

204

Archived mailings could not be found.

400

Invalid request or 'next-cursor' is expired. Make sure you requested no more than 10000 results.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/vnd.optivo.broadmail.v1+json

200The information about the archived mailing was retrieved successfully.