Mural API changelog 2022-05-12

Summary

Create and update endpoints are moved out of Preview mode. Requests to these endpoints should no longer include the Accept: vnd.mural.preview header.

The payloads when creating, updating, and retrieving certain types of widgets have changed. See details below.

Area widget

Create an area on a mural

Remove properties from payload:

  • hidden
  • hideEditor
  • hideOwner
  • locked
  • lockedByFacilitator
  • rotation

Rename style properties:

  • strokeColor -> borderColor
  • strokeStyle -> borderStyle
  • strokeWidth -> borderWidth

Update an area on a mural

Remove properties from payload:

  • rotation

Rename style properties:

  • strokeColor -> borderColor
  • strokeStyle -> borderStyle
  • strokeWidth -> borderWidth

Get area widgets

Rename style properties:

  • strokeColor -> borderColor
  • strokeStyle -> borderStyle
  • strokeWidth -> borderWidth

Shape widgets

Create a shape widget on a mural

Rename style properties:

  • strokeColor -> borderColor
  • strokeStyle -> borderStyle
  • strokeWidth -> borderWidth

Update a shape widget on a mural

Rename style properties:

  • strokeColor -> borderColor
  • strokeStyle -> borderStyle
  • strokeWidth -> borderWidth

Get shape widgets

Rename style properties:

  • strokeColor -> borderColor
  • strokeStyle -> borderStyle
  • strokeWidth -> borderWidth

Text/title widgets

General

Document that the text property supports HTML tags to style the text.

Create a textbox on a mural

Add properties to payload:

  • style.font

Update a textbox on a mural

Add properties to payload:

  • style.font

Create a title on a mural

Add properties to payload:

  • style.font

Update a title on a mural

Add properties to payload:

  • style.font

Get text widgets

Remove properties:

  • minLines

Remove style properties:

  • bold
  • italic
  • underline
  • strike
  • border

The fixedWidth property is always true for textbox widgets and false for title widgets. Textbox widgets wrap text to fit the width, while title widgets grow to fit the text.