Skip to content

Newsletters

Use these tools to manage the lifecycle of email newsletters in KlickTipp. They bring together the newsletter draft, its audience, delivery settings, readiness, and dispatch status.

For example, you can create and configure a newsletter, send a test, prepare or schedule its delivery, start the dispatch, or cancel what has not yet been sent. The email body itself is managed through the Email Editor, while further newsletter actions may be added over time.

Add SMS Newsletter Split Test Variant

Tool name: add-sms-newsletter-split-test-variant

Adds an SMS newsletter split-test variant, empty or copied from copyFromMessageId. Audience shares are redistributed evenly. Refused after the test starts; sends nothing.

Input schema

newsletterIdinteger, >= 1required

ID of an SMS newsletter created as a split test

copyFromMessageIdnull or integer, >= 1

messageId of the variant to copy; omit for an empty variant

Default:null
accountIdnull or integer, >= 1

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

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

Output schema

accountIdintegerrequired
campaignIdintegerrequired
channelstringrequired
Enum:"email""sms"
testSizePercentintegerrequired
testDurationHoursintegerrequired
winnerBystring or nullrequired
Enum:"opens""clicks""conversions""revenue"null
hasStartedbooleanrequired
needsMoreVariantsbooleanrequired
variantsArray of objectsrequired
Output example
{ "accountId": 0, "campaignId": 0, "channel": "email", "testSizePercent": 0, "testDurationHours": 0, "winnerBy": "opens", "hasStarted": true, "needsMoreVariants": true, "variants": [ { "messageId": 0, "label": "string", "name": "string", "email": { "emailId": 0, "subject": "string", "preheader": "string", "reportSpamHeader": true, "editorUrl": "string", "contentUrl": "string" }, "sms": { "smsId": 0, "text": "string", "senderName": "string", "provider": "string", "linkTracking": true, "contentUrl": "string" } } ] }