Skip to content
/
Activate Newsletter

Activate Newsletter

Tool name: prepare-newsletter-dispatch

Prepares the dispatch of an email newsletter, immediately or at a given moment, and sends, schedules and publishes nothing itself. It checks permission, published content, audience and sender, estimates the recipients and returns a short-lived single-use confirmation URL bound to that exact summary. Only the logged-in user, by opening the URL in KlickTipp and confirming there, hands the newsletter over -- that reaches real recipients and cannot be taken back. Content that was changed but not published is refused; publish it first with publish-newsletter-email-content. The mode has to be given explicitly; a scheduled moment carries its own UTC offset. If a bound value changes or the URL expires, a new preparation is needed. The dispatch state is read through get-newsletter with deliveryStatus.

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
confirmationUrlstringrequired
expiresAtstringrequired
summaryobjectrequired
publishesContentbooleanrequired
recoveryReadstringrequired
Output example
{
  "outcome": "string",
  "confirmationUrl": "string",
  "expiresAt": "string",
  "summary": {
    "accountId": 0,
    "newsletterId": 0,
    "name": "string",
    "newsletterStatus": "string",
    "audience": {
      "includeTags": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "includeTagsMatch": "string",
      "excludeTags": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "excludeTagsMatch": "string",
      "savedAudience": {
        "id": 0,
        "name": "string"
      },
      "mode": "string"
    },
    "estimatedRecipientsMin": 0,
    "estimatedRecipientsMax": 0,
    "sender": {
      "senderNameMode": "string",
      "senderName": "string",
      "senderEmailMode": "string",
      "senderEmail": "string",
      "replyToEmailMode": "string",
      "replyToEmail": "string",
      "senderDomainMode": "string",
      "senderDomain": "string",
      "signature": {
        "mode": "string",
        "id": 0,
        "name": "string"
      },
      "senderIdentity": {
        "effectiveSenderEmail": "string",
        "customerDomain": "string",
        "normalizedSenderDomain": "string",
        "status": "ready",
        "isUsable": true,
        "senderEmailOptions": [
          "string"
        ],
        "senderDomainOptions": [
          "string"
        ]
      }
    },
    "signatureSelectionExplanation": "string",
    "mode": "string",
    "sendAt": "string",
    "emails": [
      {
        "emailId": 0,
        "subject": "string",
        "editorUrl": "string",
        "requiresPublish": true
      }
    ],
    "requiresPublish": true
  },
  "publishesContent": true,
  "recoveryRead": "string"
}