Update a sticky note on a mural

patch

https://app.mural.co/api/public/{version}/murals/{muralId}/widgets/sticky-note/{widgetId}

Update a sticky note widget on a mural.

Authorization scope: murals:write

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

muralId

string

required

Unique identifier of a mural.

widgetId

string

required

Unique identifier of a widget.

Body Params

htmlText

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.

height

number

The height of the widget in px.

hidden

boolean

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

hyperlink

uri

length between 0 and 1024

The URL used in the widget.

hyperlinkTitle

string

Text displayed on the hyperlink button.

instruction

string

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

parentId

string

The ID of the area widget that contains the widget.

presentationIndex

number

The list order of the widget in the outline.

rotation

number

≥ 0

The angle of widget rotation in degrees.

style

object

Style properties of the widget.

tags

text

string

The text in the widget.

title

string

The title of the widget in the outline.

width

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

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

200Success.

400Request invalid or malformed

401No authorization

403Access denied

404The resource was not found.

500API error