Get information about all transactional mails

get

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

Get detailed information about all transactional mails, such as status, type, starting date, successor node or grid location. You can filter for mailings assigned to a folder or limit the number of retrieved mailings.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientId

string

required

Client ID

Query Params

offset

int32

Mailings offset

Default value : 0

limit

int32

Maximum number of transactional mails

Default value: 100

mediaType

string

Filter mailings by media type

Available values : email, sms, letter, push

resultView

string

enum

Defaults to SUMMARY

Choose whether to retrieve a DETAILED view including all nodes (messages, recipient lists, target groups) or a SUMMARY of metadata.

Note: The more campaigns you have, the more time the detailed view takes to load.

Allowed:

status

string

Filter mailings by status

Available values : invalid, activationRequired, activated, canceled, paused, running, finished

sort

string

enum

Defaults to created

Sort result by specific criteria

folderId

int64

Filter mailings assigned to a folder

direction

string

enum

Sort order

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

Invalid limit request. Change the limit to less than 10000.

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

200A list of transactional mails of a client was retrieved (empty if none exists).