Skip to content
/
Add Email Menu

Add Email Menu

Tool name: add-email-editor-menu

Puts a menu into the column whose uuid it names, with its entries, and answers with the uuid of the new block. One call and one revision rather than two. What the entries do not name -- how a link opens, the separator, the spacing -- comes from the menu this email already has. 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

columnUuidstringrequired

The uuid of the column the block goes into

itemsArray of objects, [ 1 .. 30 ] itemsrequired

The menu entries, left to right

positionnull or integer, >= 0

Where it goes inside the column, counted from zero; omit to append

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",
  "columnUuid": "string",
  "items": [
    {
      "text": "string",
      "href": "string"
    }
  ],
  "position": 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"
}