Write Email Text

Tool name: update-email-editor-text

Writes the words of text blocks -- heading, text, paragraph, list and custom HTML -- each named by its uuid. The typography of a text block lives in its own markup, so the markup that was read for that block, with its wrapper div and its style attributes kept and only the words swapped, is what preserves it -- a bare

new text

throws the font size, line height and colours away. Several blocks in one call, and nothing else in the email is touched. Bound to the contentRevision of the read and refused whole if anything in it fails, so nothing half-written is stored. Drafts only. Saves the draft; publishing is publish-newsletter-email-content.

Input schema

editorUrlstring, [ 12 .. 500 ] charactersrequired

Editor URL of the email, as the read returned it

contentRevisionstring, [ 7 .. 100 ] charactersrequired

The contentRevision of the read this change is based on

blocksArray of objects, [ 1 .. 100 ] itemsrequired

The blocks to write, each by uuid and its complete markup; a heading may add its level

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",
  "blocks": [
    {
      "uuid": "string",
      "html": "string",
      "level": "h1"
    }
  ],
  "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"
}