API Reference
CommunityMy apps

Update a shape widget on a mural

patch
https://app.mural.co/api/public/{version}/murals//widgets/shape/

Update a shape widget on a mural.

Authorization scope: murals:write

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of a mural.

string
required

Unique identifier of a widget.

Body Params
number

The height of the widget in px.

boolean

If true, the widget is hidden from non-facilitators. Applies only when the widget is in the outline.

string

The text in the widget. It supports inline formatting using HTML tags.
<b> - bold text
<i> - italic text
<u> - underline text
<s> - strike text
<ul> - unordered list of items
<ol> - ordered list of items
<li> - list item.
When set, the htmlText property takes priority over the text property.
When using htmlText, the inline HTML tags override style properties such as bold, italic, strike, and underline.

string

The instructions for a section of the outline. This text can only be added and modified by a facilitator.

string

The ID of the area widget that contains the widget.

number

The list order of the widget in the outline.

number
≥ 0

The angle of widget rotation in degrees.

style
object

Style properties of the widget.

string

The text in the widget.

string

The title of the widget in the outline.

number

The width of the widget in px.

number

The horizontal position of the widget in px. This is the distance from the left of the parent widget, such as an area. If the widget has no parent widget, this is the distance from the left of the mural.

number

The vertical position of the widget in px. This is the distance from the top of the parent widget, such as an area. If the widget has no parent widget, this is the distance from the top of the mural.

Responses

Updated about 1 month ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 month ago