Skip to content
/
Get Newsletter

Get Newsletter

Tool name: get-newsletter

Returns one email newsletter of a KlickTipp account: identity, lifecycle state, editor type, split-test flag and deep links. Everything else is a projection requested through "include": "metadata" (name, note, labels, subject), "audience", "deliveryConfiguration" (sender, reply address, signature), "deliveryStatus" (send date, recipients, counters, what is missing), "audienceReach" (contacts it would reach now) and "conversionPixel" (tracking snippets for a thank-you page, one per sender domain; hand one to the user verbatim). The body is not here -- read it with get-email-editor-content. Reads only; requested projections are answered whole or the call fails. A split test has one email per variant and no single email: emailId, contentUrl and metadata.subject are null, splitTestVariants lists the variants, and deliveryConfiguration needs one of their editorUrl.

Input schema

newsletterIdinteger, >= 1required

ID of the newsletter, as shown in the KlickTipp app URL

includeArray of strings, <= 6 items, unique

Projections to add: "metadata", "audience", "deliveryConfiguration", "deliveryStatus", "audienceReach", "conversionPixel"; omit for identity and lifecycle only. The body is get-email-editor-content

Default:null
Items Enum:"metadata""audience""deliveryConfiguration""deliveryStatus""audienceReach""conversionPixel"
editorUrlnull or string, [ 12 .. 500 ] characters

Editor URL naming one variant of a split test, from splitTestVariants; omit for a newsletter with a single email

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,
  "include": null,
  "editorUrl": null,
  "accountId": null
}

Output schema

One of:
accountIdintegerrequired
newsletterIdintegerrequired
emailIdinteger or nullrequired

Null for a split test: each variant has its own email.

createdAtstringrequired
newsletterStatusstringrequired
Enum:"draft""scheduled""outgoing""sent"
usageTypestringrequired
Enum:"newsletter""newsletter-split-test"
emailEditorstring or nullrequired
Enum:"drag-and-drop""rich-text"null
isSplitTestbooleanrequired
splitTestVariantsArray of objects or null

The variants of a split test, each with the editorUrl that reads it; null for a standard newsletter.

editUrlstringrequired
contentUrlstring or nullrequired
scheduleUrlstringrequired
statisticsUrlstringrequired
metadataobject
audienceobject
deliveryConfigurationobject
deliveryStatusobject
audienceReachobject
Output example
{
  "accountId": 0,
  "newsletterId": 0,
  "emailId": 0,
  "createdAt": "string",
  "newsletterStatus": "draft",
  "usageType": "newsletter",
  "emailEditor": "drag-and-drop",
  "isSplitTest": true,
  "splitTestVariants": [
    {
      "emailId": 0,
      "label": "string",
      "name": "string",
      "subject": "string",
      "editorUrl": "string"
    }
  ],
  "editUrl": "string",
  "contentUrl": "string",
  "scheduleUrl": "string",
  "statisticsUrl": "string",
  "metadata": {},
  "audience": {},
  "deliveryConfiguration": {
    "senderIdentity": {
      "effectiveSenderEmail": "string",
      "customerDomain": "string",
      "normalizedSenderDomain": "string",
      "status": "ready",
      "isUsable": true,
      "senderEmailOptions": [
        "string"
      ],
      "senderDomainOptions": [
        "string"
      ]
    }
  },
  "deliveryStatus": {
    "accountId": 0,
    "observedAt": "string",
    "newsletterId": 0,
    "name": "string",
    "newsletterStatus": "draft",
    "dispatchConfigured": true,
    "mode": "immediate",
    "sendDate": "string",
    "sendProcessFinishedAt": "string",
    "estimatedRecipients": 0,
    "sentCount": 0,
    "failedCount": 0,
    "totalOpenCount": 0,
    "uniqueOpenCount": 0,
    "totalClickCount": 0,
    "uniqueClickCount": 0,
    "hardBounceCount": 0,
    "softBounceCount": 0,
    "spamBounceCount": 0,
    "spamComplaintCount": 0,
    "unsubscriptionCount": 0,
    "canBeCancelled": true,
    "missingRequirements": [
      "string"
    ],
    "readyToSend": true,
    "scheduleUrl": "string",
    "statisticsUrl": "string"
  },
  "audienceReach": {
    "accountId": 0,
    "newsletterId": 0,
    "minRecipients": 0,
    "maxRecipients": 0,
    "observedAt": "string"
  }
}