Mural

App · 29 actions

Run your Mural whiteboards from a workflow: create rooms and murals, add and edit sticky notes and text boxes, tag ideas and read what your team put on a board.

Actions

ActionWhat it does
Add sticky noteAdd a sticky note to a mural.
Add text boxAdd a text box to a mural.
Create folderCreate a folder in a room, optionally inside another folder.
Create muralCreate a blank mural in a room.
Create roomCreate a room in a workspace.
Create tagCreate a tag on a mural.
Delete muralDelete a mural for good.
Delete roomDelete a room and the murals in it.
Delete tagDelete a tag from a mural.
Delete widgetRemove a sticky note, text box or any other widget from a mural.
Duplicate muralCopy a mural, with everything on it, into a room.
Get muralGet one mural with its links and settings.
Get my profileGet the name and email of the Mural account that is connected.
Get roomGet one room.
Get widgetGet one widget from a mural.
Get workspaceGet one workspace.
List foldersList the folders in a room.
List muralsList the murals of a workspace, or only those in one of its rooms.
List people on a muralList the people who have access to a mural and whether they own or facilitate it.
List roomsList the rooms of a workspace that the connected account can see.
List tagsList the tags defined on a mural.
List widgetsList what is on a mural: sticky notes, text boxes, shapes and the rest.
List workspacesList the workspaces the connected account belongs to.
Search muralsFind murals in a workspace by title or content.
Search roomsFind rooms in a workspace by name.
Update muralRename a mural, archive or restore it, mark it a favourite, move it to a folder or change its background.
Update roomRename a room, change whether it is open or private, or mark it a favourite.
Update sticky noteChange a sticky note's text, colour, position or size.
Update tagChange a tag's text or colours.

Add sticky note

Add a sticky note to a mural.

Inputs

Muralmural_idtextRequired
The mural. Pick one, or give its ID from an earlier step.
TexttexttextRequired
What the sticky note says.
Left positionxnumber
Where the left edge goes on the canvas. Default 0.
Top positionynumber
Where the top edge goes on the canvas. Default 0.
Shapeshapetext
Square or circle. Default square.One of: rectangle (Square), circle. Default: rectangle.
Colourbackground_colortext
The note's colour. A hex colour such as #FFEB00.
Widthwidthnumber
Width in pixels.
Heightheightnumber
Height in pixels.
Inside areaparent_idtext
Put it inside this area, by its widget ID.

Outputs

widgetobject
The widget
Example output
{
  "widget": {
    "background_color": "#FFEB00FF",
    "created_by": "Ada Lovelace",
    "created_on": "2026-01-01T00:00:00Z",
    "height": 138,
    "hidden": false,
    "id": "0-1608152669001",
    "link": "https://app.mural.co/t/acme1234/m/acme1234/1608152669000?wid=0-1608152669001",
    "locked": false,
    "parent_id": "",
    "rotation": 0,
    "shape": "rectangle",
    "tags": [],
    "text": "Ship it",
    "title": "",
    "type": "sticky note",
    "updated_by": "Ada Lovelace",
    "updated_on": "2026-01-01T00:00:00Z",
    "width": 138,
    "x": 0,
    "y": 0
  }
}

Add text box

Add a text box to a mural.

Inputs

Muralmural_idtextRequired
The mural. Pick one, or give its ID from an earlier step.
TexttexttextRequired
What the text box says.
Left positionxnumber
Where the left edge goes on the canvas. Default 0.
Top positionynumber
Where the top edge goes on the canvas. Default 0.
Widthwidthnumber
Width in pixels.
Heightheightnumber
Height in pixels.
Font sizefont_sizenumber
Text size in points.
Alignmenttext_aligntext
How the text lines up.One of: left, center, right.

Outputs

widgetobject
The widget
Example output
{
  "widget": {
    "background_color": "#FFEB00FF",
    "created_by": "Ada Lovelace",
    "created_on": "2026-01-01T00:00:00Z",
    "height": 138,
    "hidden": false,
    "id": "0-1608152669001",
    "link": "https://app.mural.co/t/acme1234/m/acme1234/1608152669000?wid=0-1608152669001",
    "locked": false,
    "parent_id": "",
    "rotation": 0,
    "shape": "rectangle",
    "tags": [],
    "text": "Ship it",
    "title": "",
    "type": "sticky note",
    "updated_by": "Ada Lovelace",
    "updated_on": "2026-01-01T00:00:00Z",
    "width": 138,
    "x": 0,
    "y": 0
  }
}

Create folder

Create a folder in a room, optionally inside another folder.

Inputs

Roomroom_idtextRequired
The room. Pick one, or give its ID from an earlier step.
NamenametextRequired
The folder's name.
Inside folderparent_idtext
Create it inside this folder. Leave blank for the room's top level.

Outputs

folderobject
The folder
Example output
{
  "folder": {
    "id": "f-1",
    "name": "Q1",
    "subfolder_count": 0
  }
}

Create mural

Create a blank mural in a room.

Inputs

Roomroom_idtextRequired
The room. Pick one, or give its ID from an earlier step.
Titletitletext
The mural's title.
Folderfolder_idtext
Put the mural in this folder of its room.
Background colourbackground_colortext
The canvas colour. A hex colour such as #FFEB00.
Infinite canvasinfinitetrue/false
A canvas with no edges. Mural's default is on.
Widthwidthnumber
Canvas width in pixels, for a canvas with edges.
Heightheightnumber
Canvas height in pixels, for a canvas with edges.

Outputs

muralobject
The mural
Example output
{
  "mural": {
    "confidential": false,
    "created_by": "Ada Lovelace",
    "created_on": "2026-01-01T00:00:00Z",
    "embed_link": "",
    "favorite": false,
    "folder_id": "",
    "height": 0,
    "id": "acme1234.1608152669000",
    "infinite": true,
    "link": "https://app.mural.co/t/acme1234/m/acme1234/1608152669000",
    "room_id": "1608152669000",
    "status": "active",
    "thumbnail_url": "https://app.mural.co/thumb.jpg",
    "title": "Retro",
    "updated_by": "Ada Lovelace",
    "updated_on": "2026-01-02T00:00:00Z",
    "width": 0,
    "workspace_id": "acme1234"
  }
}

Create room

Create a room in a workspace.

Inputs

Workspaceworkspace_idtextRequired
The workspace. Pick one, or give its ID from an earlier step.
NamenametextRequired
The room's name.
Typeroom_typetext
Open rooms can be joined by anyone in the workspace. Default open.One of: open (Open (everyone in the workspace can join)), private (Private (invite only)). Default: open.
Confidentialconfidentialtrue/false
Mark the room's murals as confidential.

Outputs

roomobject
The room
Example output
{
  "room": {
    "confidential": false,
    "created_by": "Ada Lovelace",
    "created_on": "2026-01-01T00:00:00Z",
    "description": "Quarterly planning",
    "favorite": false,
    "id": "1608152669000",
    "link": "https://app.mural.co/invitation/room/1608152669000",
    "name": "Planning",
    "type": "open",
    "updated_by": "Ada Lovelace",
    "updated_on": "2026-01-02T00:00:00Z",
    "workspace_id": "acme1234"
  }
}

Create tag

Create a tag on a mural.

Inputs

Muralmural_idtextRequired
The mural. Pick one, or give its ID from an earlier step.
TexttexttextRequired
The tag's text.
Background colourbackground_colortext
The tag's fill. A hex colour such as #FFEB00.
Border colourborder_colortext
The tag's outline. A hex colour such as #FFEB00.
Text colourcolortext
The tag's text. A hex colour such as #FFEB00.

Outputs

tagobject
The tag
Example output
{
  "tag": {
    "background_color": "#FFEB00FF",
    "border_color": "#000000FF",
    "color": "#000000FF",
    "id": "tag-1",
    "text": "Idea"
  }
}

Delete mural

Delete a mural for good.

Inputs

Muralmural_idtextRequired
The mural. Pick one, or give its ID from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
mural_idtext
The ID of the deleted mural
Example output
{
  "deleted": true,
  "mural_id": "acme1234.1608152669000"
}

Delete room

Delete a room and the murals in it.

Inputs

Roomroom_idtextRequired
The room. Pick one, or give its ID from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
room_idtext
The ID of the deleted room
Example output
{
  "deleted": true,
  "room_id": "1608152669000"
}

Delete tag

Delete a tag from a mural.

Inputs

Muralmural_idtextRequired
The mural. Pick one, or give its ID from an earlier step.
Tagtag_idtextRequired
The tag. Pick one, or give its ID from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
mural_idtext
The mural it was on
tag_idtext
The ID of the deleted tag
Example output
{
  "deleted": true,
  "mural_id": "acme1234.1608152669000",
  "tag_id": "tag-1"
}

Delete widget

Remove a sticky note, text box or any other widget from a mural.

Inputs

Muralmural_idtextRequired
The mural. Pick one, or give its ID from an earlier step.
Widgetwidget_idtextRequired
The widget on the mural. Pick one, or give its ID from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
mural_idtext
The mural it was on
widget_idtext
The ID of the deleted widget
Example output
{
  "deleted": true,
  "mural_id": "acme1234.1608152669000",
  "widget_id": "0-1608152669001"
}

Duplicate mural

Copy a mural, with everything on it, into a room.

Inputs

Muralmural_idtextRequired
The mural. Pick one, or give its ID from an earlier step.
Roomroom_idtextRequired
The room. Pick one, or give its ID from an earlier step.
Title of the copytitletextRequired
The copy's title.

Outputs

muralobject
The new mural
Example output
{
  "mural": {
    "confidential": false,
    "created_by": "Ada Lovelace",
    "created_on": "2026-01-01T00:00:00Z",
    "embed_link": "",
    "favorite": false,
    "folder_id": "",
    "height": 0,
    "id": "acme1234.1608152669000",
    "infinite": true,
    "link": "https://app.mural.co/t/acme1234/m/acme1234/1608152669000",
    "room_id": "1608152669000",
    "status": "active",
    "thumbnail_url": "https://app.mural.co/thumb.jpg",
    "title": "Retro",
    "updated_by": "Ada Lovelace",
    "updated_on": "2026-01-02T00:00:00Z",
    "width": 0,
    "workspace_id": "acme1234"
  }
}

Get mural

Get one mural with its links and settings.

Inputs

Muralmural_idtextRequired
The mural. Pick one, or give its ID from an earlier step.

Outputs

muralobject
The mural
Example output
{
  "mural": {
    "confidential": false,
    "created_by": "Ada Lovelace",
    "created_on": "2026-01-01T00:00:00Z",
    "embed_link": "",
    "favorite": false,
    "folder_id": "",
    "height": 0,
    "id": "acme1234.1608152669000",
    "infinite": true,
    "link": "https://app.mural.co/t/acme1234/m/acme1234/1608152669000",
    "room_id": "1608152669000",
    "status": "active",
    "thumbnail_url": "https://app.mural.co/thumb.jpg",
    "title": "Retro",
    "updated_by": "Ada Lovelace",
    "updated_on": "2026-01-02T00:00:00Z",
    "width": 0,
    "workspace_id": "acme1234"
  }
}

Get my profile

Get the name and email of the Mural account that is connected.

Inputs

None.

Outputs

userobject
The connected person
Example output
{
  "user": {
    "avatar_url": "https://app.mural.co/user1.jpg",
    "company_name": "Acme",
    "email": "user@example.com",
    "first_name": "Ada",
    "id": "u1651c4ac9145e4b8497d5982",
    "is_facilitator": false,
    "is_owner": false,
    "last_name": "Lovelace",
    "type": "member"
  }
}

Get room

Get one room.

Inputs

Roomroom_idtextRequired
The room. Pick one, or give its ID from an earlier step.

Outputs

roomobject
The room
Example output
{
  "room": {
    "confidential": false,
    "created_by": "Ada Lovelace",
    "created_on": "2026-01-01T00:00:00Z",
    "description": "Quarterly planning",
    "favorite": false,
    "id": "1608152669000",
    "link": "https://app.mural.co/invitation/room/1608152669000",
    "name": "Planning",
    "type": "open",
    "updated_by": "Ada Lovelace",
    "updated_on": "2026-01-02T00:00:00Z",
    "workspace_id": "acme1234"
  }
}

Get widget

Get one widget from a mural.

Inputs

Muralmural_idtextRequired
The mural. Pick one, or give its ID from an earlier step.
Widgetwidget_idtextRequired
The widget on the mural. Pick one, or give its ID from an earlier step.

Outputs

widgetobject
The widget
Example output
{
  "widget": {
    "background_color": "#FFEB00FF",
    "created_by": "Ada Lovelace",
    "created_on": "2026-01-01T00:00:00Z",
    "height": 138,
    "hidden": false,
    "id": "0-1608152669001",
    "link": "https://app.mural.co/t/acme1234/m/acme1234/1608152669000?wid=0-1608152669001",
    "locked": false,
    "parent_id": "",
    "rotation": 0,
    "shape": "rectangle",
    "tags": [],
    "text": "Ship it",
    "title": "",
    "type": "sticky note",
    "updated_by": "Ada Lovelace",
    "updated_on": "2026-01-01T00:00:00Z",
    "width": 138,
    "x": 0,
    "y": 0
  }
}

Get workspace

Get one workspace.

Inputs

Workspaceworkspace_idtextRequired
The workspace. Pick one, or give its ID from an earlier step.

Outputs

workspaceobject
The workspace
Example output
{
  "workspace": {
    "created_by": "Ada Lovelace",
    "created_on": "2026-01-01T00:00:00Z",
    "id": "acme1234",
    "link": "https://app.mural.co/t/acme1234",
    "locked": false,
    "name": "Acme",
    "suspended": false
  }
}

List folders

List the folders in a room.

Inputs

Roomroom_idtextRequired
The room. Pick one, or give its ID from an earlier step.
Page sizelimitnumber
How many to return, 1 to 100. The default is 25.From 1 to 100. Default: 25.
Next page tokennext_tokentext
To get the next page, use 'next_token' from the last page's result.

Outputs

countnumber
How many are in this answer
folderslist
The folders
has_moretrue/false
True when Mural has more after these
next_tokentext
The 'Next page token' value that gets the next page
Example output
{
  "count": 1,
  "folders": [
    {
      "id": "f-1",
      "name": "Q1",
      "subfolder_count": 0
    }
  ],
  "has_more": false,
  "next_token": ""
}

List murals

List the murals of a workspace, or only those in one of its rooms.

Inputs

Workspaceworkspace_idtextRequired
The workspace. Pick one, or give its ID from an earlier step.
Only in roomroom_idtext
Only murals in this room. Leave blank for the whole workspace.
Statusstatustext
Only active or only archived murals.One of: active, archived.
Sort bysort_bytext
How to order the murals.One of: lastModified (Last modified), lastCreated (Newest first), oldest (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. The default is 25.From 1 to 100. Default: 25.
Next page tokennext_tokentext
To get the next page, use 'next_token' from the last page's result.

Outputs

countnumber
How many are in this answer
has_moretrue/false
True when Mural has more after these
muralslist
The murals
next_tokentext
The 'Next page token' value that gets the next page
Example output
{
  "count": 1,
  "has_more": false,
  "murals": [
    {
      "confidential": false,
      "created_by": "Ada Lovelace",
      "created_on": "2026-01-01T00:00:00Z",
      "embed_link": "",
      "favorite": false,
      "folder_id": "",
      "height": 0,
      "id": "acme1234.1608152669000",
      "infinite": true,
      "link": "https://app.mural.co/t/acme1234/m/acme1234/1608152669000",
      "room_id": "1608152669000",
      "status": "active",
      "thumbnail_url": "https://app.mural.co/thumb.jpg",
      "title": "Retro",
      "updated_by": "Ada Lovelace",
      "updated_on": "2026-01-02T00:00:00Z",
      "width": 0,
      "workspace_id": "acme1234"
    }
  ],
  "next_token": ""
}

List people on a mural

List the people who have access to a mural and whether they own or facilitate it.

Inputs

Muralmural_idtextRequired
The mural. Pick one, or give its ID from an earlier step.
Page sizelimitnumber
How many to return, 1 to 100. The default is 25.From 1 to 100. Default: 25.
Next page tokennext_tokentext
To get the next page, use 'next_token' from the last page's result.

Outputs

countnumber
How many are in this answer
has_moretrue/false
True when Mural has more after these
next_tokentext
The 'Next page token' value that gets the next page
userslist
The people with access
Example output
{
  "count": 1,
  "has_more": false,
  "next_token": "",
  "users": [
    {
      "avatar_url": "https://app.mural.co/user1.jpg",
      "company_name": "Acme",
      "email": "user@example.com",
      "first_name": "Ada",
      "id": "u1651c4ac9145e4b8497d5982",
      "is_facilitator": false,
      "is_owner": false,
      "last_name": "Lovelace",
      "type": "member"
    }
  ]
}

List rooms

List the rooms of a workspace that the connected account can see.

Inputs

Workspaceworkspace_idtextRequired
The workspace. Pick one, or give its ID from an earlier step.
Page sizelimitnumber
How many to return, 1 to 100. The default is 25.From 1 to 100. Default: 25.
Next page tokennext_tokentext
To get the next page, use 'next_token' from the last page's result.

Outputs

countnumber
How many are in this answer
has_moretrue/false
True when Mural has more after these
next_tokentext
The 'Next page token' value that gets the next page
roomslist
The rooms
Example output
{
  "count": 1,
  "has_more": false,
  "next_token": "",
  "rooms": [
    {
      "confidential": false,
      "created_by": "Ada Lovelace",
      "created_on": "2026-01-01T00:00:00Z",
      "description": "Quarterly planning",
      "favorite": false,
      "id": "1608152669000",
      "link": "https://app.mural.co/invitation/room/1608152669000",
      "name": "Planning",
      "type": "open",
      "updated_by": "Ada Lovelace",
      "updated_on": "2026-01-02T00:00:00Z",
      "workspace_id": "acme1234"
    }
  ]
}

List tags

List the tags defined on a mural.

Inputs

Muralmural_idtextRequired
The mural. Pick one, or give its ID from an earlier step.

Outputs

countnumber
How many tags there are
tagslist
The tags
Example output
{
  "count": 1,
  "tags": [
    {
      "background_color": "#FFEB00FF",
      "border_color": "#000000FF",
      "color": "#000000FF",
      "id": "tag-1",
      "text": "Idea"
    }
  ]
}

List widgets

List what is on a mural: sticky notes, text boxes, shapes and the rest.

Inputs

Muralmural_idtextRequired
The mural. Pick one, or give its ID from an earlier step.
Kinds of widgetwidget_typeslist
Only these kinds. Leave empty for everything.One or more of: sticky notes, texts (Text boxes), shapes, areas, arrows, comments, images, files, icons.
Inside widgetparent_idtext
Only widgets inside this area or widget, by its ID.
Page sizelimitnumber
How many to return, 1 to 100. The default is 25.From 1 to 100. Default: 25.
Next page tokennext_tokentext
To get the next page, use 'next_token' from the last page's result.

Outputs

countnumber
How many are in this answer
has_moretrue/false
True when Mural has more after these
next_tokentext
The 'Next page token' value that gets the next page
widgetslist
The widgets
Example output
{
  "count": 1,
  "has_more": false,
  "next_token": "",
  "widgets": [
    {
      "background_color": "#FFEB00FF",
      "created_by": "Ada Lovelace",
      "created_on": "2026-01-01T00:00:00Z",
      "height": 138,
      "hidden": false,
      "id": "0-1608152669001",
      "link": "https://app.mural.co/t/acme1234/m/acme1234/1608152669000?wid=0-1608152669001",
      "locked": false,
      "parent_id": "",
      "rotation": 0,
      "shape": "rectangle",
      "tags": [],
      "text": "Ship it",
      "title": "",
      "type": "sticky note",
      "updated_by": "Ada Lovelace",
      "updated_on": "2026-01-01T00:00:00Z",
      "width": 138,
      "x": 0,
      "y": 0
    }
  ]
}

List workspaces

List the workspaces the connected account belongs to.

Inputs

Page sizelimitnumber
How many to return, 1 to 100. The default is 25.From 1 to 100. Default: 25.
Next page tokennext_tokentext
To get the next page, use 'next_token' from the last page's result.

Outputs

countnumber
How many are in this answer
has_moretrue/false
True when Mural has more after these
next_tokentext
The 'Next page token' value that gets the next page
workspaceslist
The workspaces
Example output
{
  "count": 1,
  "has_more": false,
  "next_token": "",
  "workspaces": [
    {
      "created_by": "Ada Lovelace",
      "created_on": "2026-01-01T00:00:00Z",
      "id": "acme1234",
      "link": "https://app.mural.co/t/acme1234",
      "locked": false,
      "name": "Acme",
      "suspended": false
    }
  ]
}

Search murals

Find murals in a workspace by title or content.

Inputs

Workspaceworkspace_idtextRequired
The workspace. Pick one, or give its ID from an earlier step.
Search textquerytextRequired
Words to look for.
Only in roomroom_idtext
Only search this room. Leave blank for the whole workspace.
Page sizelimitnumber
How many to return, 1 to 100. The default is 25.From 1 to 100. Default: 25.
Next page tokennext_tokentext
To get the next page, use 'next_token' from the last page's result.

Outputs

countnumber
How many are in this answer
has_moretrue/false
True when Mural has more after these
muralslist
The matching murals
next_tokentext
The 'Next page token' value that gets the next page
Example output
{
  "count": 1,
  "has_more": false,
  "murals": [
    {
      "confidential": false,
      "created_by": "Ada Lovelace",
      "created_on": "2026-01-01T00:00:00Z",
      "embed_link": "",
      "favorite": false,
      "folder_id": "",
      "height": 0,
      "id": "acme1234.1608152669000",
      "infinite": true,
      "link": "https://app.mural.co/t/acme1234/m/acme1234/1608152669000",
      "room_id": "1608152669000",
      "status": "active",
      "thumbnail_url": "https://app.mural.co/thumb.jpg",
      "title": "Retro",
      "updated_by": "Ada Lovelace",
      "updated_on": "2026-01-02T00:00:00Z",
      "width": 0,
      "workspace_id": "acme1234"
    }
  ],
  "next_token": ""
}

Search rooms

Find rooms in a workspace by name.

Inputs

Workspaceworkspace_idtextRequired
The workspace. Pick one, or give its ID from an earlier step.
Search textquerytextRequired
Words in the room's name.
Page sizelimitnumber
How many to return, 1 to 100. The default is 25.From 1 to 100. Default: 25.
Next page tokennext_tokentext
To get the next page, use 'next_token' from the last page's result.

Outputs

countnumber
How many are in this answer
has_moretrue/false
True when Mural has more after these
next_tokentext
The 'Next page token' value that gets the next page
roomslist
The matching rooms
Example output
{
  "count": 1,
  "has_more": false,
  "next_token": "",
  "rooms": [
    {
      "confidential": false,
      "created_by": "Ada Lovelace",
      "created_on": "2026-01-01T00:00:00Z",
      "description": "Quarterly planning",
      "favorite": false,
      "id": "1608152669000",
      "link": "https://app.mural.co/invitation/room/1608152669000",
      "name": "Planning",
      "type": "open",
      "updated_by": "Ada Lovelace",
      "updated_on": "2026-01-02T00:00:00Z",
      "workspace_id": "acme1234"
    }
  ]
}

Update mural

Rename a mural, archive or restore it, mark it a favourite, move it to a folder or change its background.

Inputs

Muralmural_idtextRequired
The mural. Pick one, or give its ID from an earlier step.
New titletitletext
A new title for the mural.
Statusstatustext
Archive the mural or make it active again.One of: active, archived.
Favouritefavoritetrue/false
Mark the mural as a favourite.
Folder IDfolder_idtext
Move the mural to this folder, using its ID from 'List folders'.
Background colourbackground_colortext
The canvas colour. A hex colour such as #FFEB00.

Outputs

muralobject
The mural
Example output
{
  "mural": {
    "confidential": false,
    "created_by": "Ada Lovelace",
    "created_on": "2026-01-01T00:00:00Z",
    "embed_link": "",
    "favorite": false,
    "folder_id": "",
    "height": 0,
    "id": "acme1234.1608152669000",
    "infinite": true,
    "link": "https://app.mural.co/t/acme1234/m/acme1234/1608152669000",
    "room_id": "1608152669000",
    "status": "active",
    "thumbnail_url": "https://app.mural.co/thumb.jpg",
    "title": "Retro",
    "updated_by": "Ada Lovelace",
    "updated_on": "2026-01-02T00:00:00Z",
    "width": 0,
    "workspace_id": "acme1234"
  }
}

Update room

Rename a room, change whether it is open or private, or mark it a favourite.

Inputs

Roomroom_idtextRequired
The room. Pick one, or give its ID from an earlier step.
New namenametext
A new name for the room.
Typeroom_typetext
Open rooms can be joined by anyone in the workspace.One of: open (Open (everyone in the workspace can join)), private (Private (invite only)).
Favouritefavoritetrue/false
Mark the room as a favourite.

Outputs

roomobject
The room
Example output
{
  "room": {
    "confidential": false,
    "created_by": "Ada Lovelace",
    "created_on": "2026-01-01T00:00:00Z",
    "description": "Quarterly planning",
    "favorite": false,
    "id": "1608152669000",
    "link": "https://app.mural.co/invitation/room/1608152669000",
    "name": "Planning",
    "type": "open",
    "updated_by": "Ada Lovelace",
    "updated_on": "2026-01-02T00:00:00Z",
    "workspace_id": "acme1234"
  }
}

Update sticky note

Change a sticky note's text, colour, position or size.

Inputs

Muralmural_idtextRequired
The mural. Pick one, or give its ID from an earlier step.
Widgetwidget_idtextRequired
The widget on the mural. Pick one, or give its ID from an earlier step.
Texttexttext
New text for the note.
Left positionxnumber
Where the left edge goes on the canvas. Default 0.
Top positionynumber
Where the top edge goes on the canvas. Default 0.
Colourbackground_colortext
The note's colour. A hex colour such as #FFEB00.
Widthwidthnumber
Width in pixels.
Heightheightnumber
Height in pixels.

Outputs

widgetobject
The widget
Example output
{
  "widget": {
    "background_color": "#FFEB00FF",
    "created_by": "Ada Lovelace",
    "created_on": "2026-01-01T00:00:00Z",
    "height": 138,
    "hidden": false,
    "id": "0-1608152669001",
    "link": "https://app.mural.co/t/acme1234/m/acme1234/1608152669000?wid=0-1608152669001",
    "locked": false,
    "parent_id": "",
    "rotation": 0,
    "shape": "rectangle",
    "tags": [],
    "text": "Ship it",
    "title": "",
    "type": "sticky note",
    "updated_by": "Ada Lovelace",
    "updated_on": "2026-01-01T00:00:00Z",
    "width": 138,
    "x": 0,
    "y": 0
  }
}

Update tag

Change a tag's text or colours.

Inputs

Muralmural_idtextRequired
The mural. Pick one, or give its ID from an earlier step.
Tagtag_idtextRequired
The tag. Pick one, or give its ID from an earlier step.
New texttexttext
New text for the tag.
Background colourbackground_colortext
The tag's fill. A hex colour such as #FFEB00.
Border colourborder_colortext
The tag's outline. A hex colour such as #FFEB00.
Text colourcolortext
The tag's text. A hex colour such as #FFEB00.

Outputs

tagobject
The tag
Example output
{
  "tag": {
    "background_color": "#FFEB00FF",
    "border_color": "#000000FF",
    "color": "#000000FF",
    "id": "tag-1",
    "text": "Idea"
  }
}

On this page