Write Email Page Style

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

Writes what the whole email starts out with: the colour around the message, the default text and link colour, the default font, how wide the message is and where it sits -- this is where "all links green", "a wider email", "one font for the whole mail" or "align the email left" are set. The colour BEHIND the message is not here: that ground is made of the rows, set with update-email-editor-row-style. The text and link colours reach a block when the block is made, so set them before adding blocks; a block carrying its own keeps it. It addresses no uuid: an email has one page. Named values only -- no CSS, and the font is named, not a stack; a web font works only if the KlickTipp editor sets it. 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

backgroundColornull or string^(#[0-9a-fA-F]{6}|#[0-9a-fA-F]{3}|transparent)$

Colour around the message, "#RRGGBB" or "transparent"

Default:null

textColornull or string^(#[0-9a-fA-F]{6}|#[0-9a-fA-F]{3}|transparent)$

Default text colour of the whole email

Default:null

linkColornull or string^(#[0-9a-fA-F]{6}|#[0-9a-fA-F]{3}|transparent)$

Default colour of every link of the email

Default:null

contentWidthnull or integer, [ 320 .. 1440 ]

Width of the message in pixels

Default:null

fontFamilynull or string

Default font of the whole email, by name; see the schema for the names

Default:null

Enum:"Arial""Courier""Georgia""Helvetica Neue""Lucida Sans""Tahoma""Times New Roman""Trebuchet MS""Verdana""ヒラギノ角ゴ Pro W3"

contentAlignnull or string

Where the message sits when the window is wider than it is

Default:null

Enum:"left""center""right"

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",
  "backgroundColor": null,
  "textColor": null,
  "linkColor": null,
  "contentWidth": null,
  "fontFamily": "Arial",
  "contentAlign": "left",
  "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"
}