Documents

The editor's whole-tab save: create or replace one tab and its elements, merged with every changeset the editor had not seen (`X-Changeset-Seen`). An API token is refused with 405 `use_changesets`: scripts and agents write tabs with changesets. A new or changed tab name is stored shortened to 60 characters.

put/documents/{id}/tabs/{tabId}

Request

  • Base URL: https://www.livediagram.app/api
  • URL: https://www.livediagram.app/api/documents/{id}/tabs/{tabId}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Owner-Id

Path parameters

idstring required
tabIdstring required

Request body

articlesobject
backgroundAnimationSpeednumber
backgroundColorstring
backgroundOpacitynumber
backgroundPattern'grid' | 'blank' | 'lines' | 'crosshatch' | 'graph' | 'confetti' | 'stripes' | 'diagonal' | 'waves' | 'bricks' | 'isometric' | 'hexagonal' | 'engineering' | 'checkerboard' | 'sparkles' | 'eggs' | 'cobwebs' | 'snowflakes' | 'candy-stripes' | 'flow' | 'drift' | 'aurora' | 'ripple' | 'ribbons'
backgroundPatternScalenumber
customColoursstring[]
esLanesSettledboolean
finish'flexible' | 'professional' | 'sketch' | 'marker'
folderstring
fontstring
idstring required
kind'diagram' | 'event-storming' | 'board' | 'sheet' | 'dashboard' | 'form'
lockedboolean
namestring required
opensIn'diagram' | 'draw' | 'workshop' | 'pages' | 'plan'
pageOrientation'portrait' | 'landscape'
patternColorstring
templateChosenboolean
themestring

Response

Success.

Changes

No recorded changes to this operation across all 1 revision of this API.