Skip to content
/
Send Newsletter Test

Send Newsletter Test

Tool name: send-newsletter-test

Sends one email newsletter as a test to a single address, so its content can be checked before it goes out -- the same send the test dialog of KlickTipp performs, with the same rules. Any address may receive one, and an address that is not a contact of the account yet becomes one and is tagged as a test recipient, which can start automations; name the address and say what it will become before calling this. A test carries the PUBLISHED content of the email: a body that was never published is refused -- publish it with publish-newsletter-email-content -- and one changed after publication is sent with a warning that the test shows the older content. The audience of the newsletter is never a recipient, and its delivery state does not change.

Input schema

newsletterIdinteger, >= 1required

ID of the newsletter to send a test of

recipientEmailstring, [ 3 .. 250 ] charactersrequired

Address to send the test to; any address, and one that is not a contact yet becomes one

accountIdnull or integer, >= 1

User ID of the account; omit for the account the access token works in

Default:null
Input example
{
  "newsletterId": 1,
  "recipientEmail": "string",
  "accountId": null
}

Output schema

accountIdintegerrequired
newsletterIdintegerrequired
emailIdintegerrequired
recipientstringrequired
audienceReachedbooleanrequired
newsletterStatusstringrequired
messagesArray of stringsrequired
warningsArray of stringsrequired
Output example
{
  "accountId": 0,
  "newsletterId": 0,
  "emailId": 0,
  "recipient": "string",
  "audienceReached": true,
  "newsletterStatus": "string",
  "messages": [
    "string"
  ],
  "warnings": [
    "string"
  ]
}