boards

Edit Menu Item

patch/v3.0/boards/{boardSlug}/blocks/{blockSlug}/items/{itemSlug}/

Request

Base URL: https://api.formaloo.me
URL: https://api.formaloo.me/v3.0/boards/{boardSlug}/blocks/{blockSlug}/items/{itemSlug}/
Auth: none declared. Required headers: x-api-key

Path parameters

blockSlugstring required

boardSlugstring required

itemSlugstring required

Headers

x-api-keystring required

The application secret provided to the client.

x-workspacestring

The value of business_identifier for the current workspace. Not required if your're using the API Key generated for your workspace.

Request body

sub_itemsobject[]

set if this menu item is a group and contains sub items.

cover_slugstring nullable

iconstring nullable

received the slug of the menu item icon, and returns the icon image's link.

slugstring

rolesstring[]

teamsstring[]

file_slugsstring[]

Send the list of slugs for the files uploaded to the storage service and used in menu item, so the files are attached to the menu item.

blocksstring[]

set if this menu item is supposed to open a set of blocks.

titlestring

positioninteger

page_titlestring nullable

page title for the page represented by this item.

type'block' | 'link' | 'embed' | 'group'

linkstring uri nullable

the link to which the menu item is set.

descriptionstring nullable

an optional description on the menu item.

contentobject

enter your content here. It should be in json format.

configobject nullable

colorstring nullable

color of item

workspace_access'owner' | 'admin' | 'team_member' | 'guest'

access_settingsobject nullable

copy_infoobject nullable

suspiciousboolean

Shows wether the board contains any suspicious menu items.

Response

cover_urlstring