Update a file on a mural

patch

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

Update a file widget on a mural.

Authorization scope: murals:write

Path Params

muralId

string

required

Unique identifier of a mural.

widgetId

string

required

Unique identifier of a widget.

Body Params

height

number

The height of the widget in px. This value will be overwritten if the file has a preview from which the final value will be extracted.

hidden

boolean

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

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.

title

string

The title in the file widget and in the outline.

width

number

The width of the widget in px. This value will be overwritten if the file has a preview from which the final value will be extracted.

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

Response

Choose an example:

application/json

200Success.

400Request invalid or malformed

401No authorization

403Access denied

404The resource was not found.

500API error