API Reference
CommunityMy apps

Create an area on a mural

post
https://app.mural.co/api/public/{version}/murals//widgets/area

Create an area 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.

Body Params
number
Defaults to 503

The height of the widget in px.

boolean
Defaults to false

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

string

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

string
enum
Defaults to free

The area layout type.

Allowed:
string

The ID of the area widget that contains the widget.

number
Defaults to -1

The list order of the widget in the outline.

boolean
Defaults to true

If true, the title is displayed.

number

The z-index stacking order of the widget.

style
object

Style properties of the widget.

string

The title of the widget in the outline.

number
Defaults to 460

The width of the widget in px.

number
Defaults to 0

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
Defaults to 0

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 2 months ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 2 months ago

Did this page help you?