API Reference
CommunityMy apps

Create an image in a mural

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

Create an image widget in 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
boolean
Defaults to false

If true, a black border is displayed around the widget.

string

The caption and outline title of the image widget.

string

The caption description text of the image widget.

number
required
Defaults to 138

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.

uri
length between 0 and 1024

The URL used in the widget.

string

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

string
required

The name of the image. The allowed image formats are: bmp, ico, gif, jpeg, jpg, png, webp.

string

The ID of the area widget that contains the widget.

number
Defaults to -1

The list order of the widget in the outline.

number
≥ 0
Defaults to 0

The angle of widget rotation in degrees.

boolean

When true, captions will be displayed for the image widget.

number

The z-index stacking order of the widget.

number
required
Defaults to 230

The width of the widget in px.

number
required

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
required

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 27 days ago

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

Updated 27 days ago