Write Email Video

Tool name: update-email-editor-video

Writes the video URL of one video block and the preview image it shows. No mail client plays a video in the inbox, so the block shows the preview image with a play icon and links to the video -- a block without a preview image stays empty. For a YouTube video the thumbnail of that video is the obvious choice. 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

uuidstringrequired

The uuid of the video block

srcnull or string, <= 2000 characters

The video URL, for example a YouTube or Vimeo page

Default:null

thumbSrcnull or string, <= 2000 characters

The preview image the block shows instead of the video

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",
  "uuid": "string",
  "src": null,
  "thumbSrc": 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"
}