Skip to content
/
Create Newsletter Draft

Create Newsletter Draft

Tool name: create-newsletter-draft

Creates an email newsletter draft in KlickTipp -- name, subject, optional preheader -- and returns newsletter ID, email ID and deep links. Nothing is sent. A draft has no audience filter yet: an unfiltered audience means every active contact of the account (mode "all_contacts"). The subject is the line every recipient sees; changing it later through update-newsletter-draft invalidates the content revisions read before. Body: block tools (update-email-editor-text and siblings). Audience: update-newsletter-draft. Sender: configure-newsletter-delivery. "splitTest" makes it a split test, irreversibly, with one variant -- more via add-newsletter-split-test-variant, settings via configure-newsletter-split-test; needs a premium account, "conversions"/"revenue" the conversion pixel, refused before creation. "emailEditor" is fixed at creation; omit it unless the account uses the previous editor.

Input schema

namestring, [ 1 .. 250 ] charactersrequired

Name of the newsletter, unique within the account

subjectstring, [ 1 .. 998 ] charactersrequired

Subject line, without HTML. It is the line every recipient sees, and no part of it is derived from anything else in this call. Correcting it later is update-newsletter-draft, which invalidates the content revisions read before

notesnull or string, <= 1000 characters

Internal note about the purpose of this newsletter, never part of the email

Default:null
preheadernull or string, <= 120 characters

Inbox preview line, at most 120 characters, without HTML; omit to leave it empty. Not part of the content document: an HTML import cannot set it

Default:null
splitTestobject or null

Makes the newsletter a split test, irreversibly: "testSizePercent" (2-98), "testDurationHours" (1-27777), "winnerBy" ("opens", "clicks", "conversions", "revenue"; the last two need the conversion pixel). All three are required and KlickTipp has no default for any of them, so any value here is a choice somebody made; together they settle what share of real recipients gets a test version and for how long. Needs a premium account; omit for a normal newsletter

Default:null
emailEditornull or string

Editor the email is created for. Omit it, which means "drag-and-drop": that is the editor KlickTipp builds on and the one every content and design tool works with. Pass "rich-text" only when the account authors in the previous HTML editor and asked for it. The choice cannot be changed afterwards

Default:null
Enum:"drag-and-drop""rich-text"
accountIdnull or integer, >= 1

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

Default:null
Input example
{
  "name": "string",
  "subject": "string",
  "notes": null,
  "preheader": null,
  "splitTest": null,
  "emailEditor": "drag-and-drop",
  "accountId": null
}

Output schema

accountIdintegerrequired
newsletterIdintegerrequired
emailIdintegerrequired
namestringrequired
newsletterStatusstringrequired
emailEditorstringrequired
subjectstringrequired
preheaderstringrequired
contentRevisionInvalidatedbooleanrequired
notesstringrequired
hasContentbooleanrequired
contentPublishedbooleanrequired
audienceobjectrequired
senderobjectrequired
editUrlstringrequired
contentUrlstringrequired
Output example
{
  "accountId": 0,
  "newsletterId": 0,
  "emailId": 0,
  "name": "string",
  "newsletterStatus": "string",
  "emailEditor": "string",
  "subject": "string",
  "preheader": "string",
  "contentRevisionInvalidated": true,
  "notes": "string",
  "hasContent": true,
  "contentPublished": true,
  "audience": {
    "includeTags": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "includeTagsMatch": "string",
    "excludeTags": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "excludeTagsMatch": "string",
    "savedAudience": {
      "id": 0,
      "name": "string"
    },
    "mode": "string"
  },
  "sender": {
    "senderNameMode": "string",
    "senderName": "string",
    "senderEmailMode": "string",
    "senderEmail": "string",
    "replyToEmailMode": "string",
    "replyToEmail": "string",
    "senderDomainMode": "string",
    "senderDomain": "string",
    "signature": {
      "mode": "string",
      "id": 0,
      "name": "string"
    }
  },
  "editUrl": "string",
  "contentUrl": "string"
}