Send a test mailing

post

https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/test

Send a test mailing to check content, layout or target groups before sending the actual mailing.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientId

int64

required

Client ID

mailingId

int64

required

Campaign mailing ID

campaignId

int64

required

Smart Campaign ID

Form Data

recipientIds

array of strings

required

Comma-separated list of recipient IDs from the provided recipient list ("recipientListId"). If a recipient is not found in the recipient list, no test mailing will be sent to this recipient.

recipientIds*

mimeType

string

Mime type of the mailing during sending (use empty string to use the mime type of the mailing).

subject

string

Subject of the test mailing (if mailing has a subject).

senderAddress

string

Sender address for test mailing (if mailing has a sender address). Must not be empty if specified.

recipientListId

string

required

Recipient list ID of the recipient list to be used for the test mailing.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

At least one request parameter is not valid

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

202The test message was sent successfully. The response contains a report on the recipients included in the test mailing (check "validRecipientAddresses" field).