Send a test mailing

1 min

POST

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

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

Path Parameters

clientIdinteger<int64>required
Description
Client ID
Format
int64
transactionalMailIdinteger<int64>required
Description
Transactional mail ID
Format
int64

Header Parameters

acceptstring
Description
Generated from available response content types
Default
application/json
Allowed
application/jsonapplication/vnd.optivo.broadmail.v1+json

Form Parameters

recipientIdsstring[]required
Description
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.
mimeTypestring
Example
text/plain, text/html, text/multipart
Description
Mime type of the mailing during sending (use empty string to use the mime type of the mailing).
subjectstring
Description
Subject of the test mailing (if mailing has a subject).
senderAddressstring
Description
Sender address for test mailing (if mailing has a sender address). Must not be empty if specified.
recipientListIdstringrequired
Description
Recipient list ID of the recipient list to be used for the test mailing.

Responses

202

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

TestMailingStartedReport
- mailingIdinteger<int64>
  Description
  Mailing ID
  Format
  int64
- validRecipientAddressesstring[]
  Description
  Valid recipient addresses
- userIdsOfRecipientsWithoutValidAddressesstring[]
  Description
  User IDs of recipients without valid addresses
- blacklistedRecipientAddressesstring[]
  Description
  Blacklisted recipient addresses
- linksobject[]
  - uriBuilderobject
  - relsstring[]
  - relstring
  - typestring
  - paramsmap<string, string>
  - titlestring
  - uristring<uri>
    Format
    uri

400At least one request parameter is not valid

curl

curl --request POST \
     --url https://api.campaign.episerver.net/rest/{clientId}/transactionalmail/{transactionalMailId}/test \
     --header 'accept: application/json' \
     --header 'content-type: application/x-www-form-urlencoded' \
     --data 'recipientIds=array' \
     --data 'recipientListId=string'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/x-www-form-urlencoded");

var urlencoded = new URLSearchParams();
urlencoded.append("recipientIds", "array");
urlencoded.append("recipientListId", "string");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: urlencoded,
   redirect: 'follow'
};

fetch("https://api.campaign.episerver.net/rest/{clientId}/transactionalmail/{transactionalMailId}/test", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "net/http"

url = URI("https://api.campaign.episerver.net/rest/{clientId}/transactionalmail/{transactionalMailId}/test")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/x-www-form-urlencoded"
request.body = "recipientIds=array&recipientListId=string"

response = https.request(request)
puts response.read_body

python

import requests

url = "https://api.campaign.episerver.net/rest/{clientId}/transactionalmail/{transactionalMailId}/test"

payload = 'recipientIds=array&recipientListId=string'
headers = {
   'accept': 'application/json',
   'content-type': 'application/x-www-form-urlencoded'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

202

// The test message was sent successfully. The response contains a report on the recipients included in the test mailing (check "validRecipientAddresses" field).
{
  "mailingId": "",
  "validRecipientAddresses": [
    ""
  ],
  "userIdsOfRecipientsWithoutValidAddresses": [
    ""
  ],
  "blacklistedRecipientAddresses": [
    ""
  ],
  "links": [
    {
      "uriBuilder": {},
      "rels": [
        ""
      ],
      "rel": "",
      "type": "",
      "params": "",
      "title": "",
      "uri": ""
    }
  ]
}

400

// At least one request parameter is not valid