Skip to content
/
Activate Newsletter

Activate Newsletter

Tool name: prepare-newsletter-dispatch

Sends or schedules an email newsletter after the user confirms the recipient estimate in the client's elicitation dialog; no, cancel or no answer sends nothing. Clients without elicitation are refused with the newsletter's schedule page, where the user sends in KlickTipp. Sent mail cannot be recalled. Unpublished edits are refused; publish them with publish-newsletter-email-content first. Requires an explicit mode and UTC offset for scheduled sends; split tests require every variant published. Read deliveryStatus via get-newsletter.

Input schema

newsletterIdinteger, >= 1required

ID of the newsletter to send

modestringrequired

"immediate" or "scheduled"; no default

Enum:"immediate""scheduled"
scheduledAtnull or string^\d{4}-\d{2}-\d{2}[Tt ]\d{2}:\d{2}(:\d{2})?([...

Moment to send at, ISO 8601 with UTC offset; required for "scheduled", forbidden for "immediate"

Default:null
accountIdnull or integer, >= 1

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

Default:null
Input example
{
  "newsletterId": 1,
  "mode": "immediate",
  "scheduledAt": null,
  "accountId": null
}

Output schema

outcomestringrequired
Enum:"sending""scheduled"
accountIdintegerrequired
newsletterIdintegerrequired
newsletterStatusstringrequired
sendAtstring or nullrequired
estimatedRecipientsintegerrequired
scheduleUrlstringrequired
statisticsUrlstringrequired
Output example
{
  "outcome": "sending",
  "accountId": 0,
  "newsletterId": 0,
  "newsletterStatus": "string",
  "sendAt": "string",
  "estimatedRecipients": 0,
  "scheduleUrl": "string",
  "statisticsUrl": "string"
}