Write Email Block Style

Tool name: update-email-editor-block-style

Writes the space around one block and how its content sits -- left, centred, right or justified. Works for a block of any kind, an image and a divider included; those two take left, centre and right only, because justifying a picture or a rule means nothing. The alignment lands where that kind of block keeps it, which is not the same field for all of them, and a read reports it from there, so what comes back is what the recipient sees. The typography of a text block is not here: its font, size, line height and colour live in the markup of that block, so they are changed with update-email-editor-text, and the size an image is shown at belongs to the image. Everything not named stays as it is. 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

uuidsArray of strings, [ 1 .. 60 ] itemsrequired

The uuids of the blocks to write; the same values land on each

paddingTopnull or integer, [ 0 .. 400 ]

Space above the block, in pixels

Default:null

paddingRightnull or integer, [ 0 .. 400 ]

Space right of the block, in pixels

Default:null

paddingBottomnull or integer, [ 0 .. 400 ]

Space below the block, in pixels

Default:null

paddingLeftnull or integer, [ 0 .. 400 ]

Space left of the block, in pixels

Default:null

textAlignnull or string

How its content sits: "left", "center", "right", or "justify" where the block is text

Default:null

Enum:"left""center""right""justify"

hideOnMobilenull or boolean

Whether the block is hidden on a phone

Default:null

hideOnDesktopnull or boolean

Whether the block is hidden on a desktop

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",
  "uuids": [
    "string"
  ],
  "paddingTop": null,
  "paddingRight": null,
  "paddingBottom": null,
  "paddingLeft": null,
  "textAlign": "left",
  "hideOnMobile": null,
  "hideOnDesktop": 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"
}