Skip to content
/
Apply Design To Email

Apply Design To Email

Tool name: replace-email-editor-content-from-template

Puts one design from the KlickTipp template catalogue into the body of an email, addressed by its editor URL. Takes the id search-email-editor-templates returned, not the number beside it; the design itself is fetched from the catalogue on the call. Works for any email the editor opens -- a newsletter draft, an automation email, a notification email -- so starting a newsletter from a design is create-newsletter-draft followed by this. Replaces the stored draft entirely, without undo, and does not publish; use publish-newsletter-email-content. Bound to the contentRevision of the preceding read. An email that already has content is refused once with a list of what it holds; call again with replaceExistingContent true to write. Returns content status, new revision and editor URL.

Input schema

editorUrlstring, [ 12 .. 500 ] charactersrequired

Editor URL of the email to write, exactly as get-email-editor-content returned it

contentRevisionstring, [ 7 .. 100 ] charactersrequired

contentRevision of the read of that email; a stale one refuses the write

templateIdstring, [ 1 .. 250 ] charactersrequired

id of the design, as search-email-editor-templates returned it

replaceExistingContentnull or boolean

true to replace content the email already has; omit on the first attempt, so the answer lists what would be lost

Default:null
accountIdnull or integer, >= 1

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

Default:null
Input example
{
  "editorUrl": "stringstring",
  "contentRevision": "strings",
  "templateId": "string",
  "replaceExistingContent": null,
  "accountId": null
}

Output schema

One of:
operationstringrequired

"replaced": the stored document is a new one; "unchanged": nothing was persisted.

Enum:"replaced""unchanged"
previousContentStatusstringrequired
Enum:"draft""published""unpublished_changes"
contentStatusstringrequired
Enum:"draft""published""unpublished_changes"
emailIdintegerrequired
contentRevisionstringrequired
warningsArray of stringsrequired
editorUrlstringrequired
createdArray of objectsrequired

What this write created, with uuids: after "addRow" the row and its columns, after "addModule" the block, plus the contentRevision the next write needs. Empty when nothing was created.

nextActionstringrequired

The content action still open: "review_and_publish_content" while the stored draft is not the dispatch content.

Enum:"review_and_publish_content""none"
Output example
{
  "operation": "replaced",
  "previousContentStatus": "draft",
  "contentStatus": "draft",
  "emailId": 0,
  "contentRevision": "string",
  "warnings": [
    "string"
  ],
  "editorUrl": "string",
  "created": [
    {
      "operation": 0,
      "type": "row",
      "uuid": "string",
      "kind": "string",
      "columns": [
        "string"
      ]
    }
  ],
  "nextAction": "review_and_publish_content"
}