boards

Block Action

Setting blocks in a menu item for a menu block

If a menu item under your menu block is supposed to open one or more blocks, the menu item's type should be block and you should send the list of blocks' slug inside it. For example: ‍‍‍

{
    "items": [
        {
            "type": "block",
            "title": "Show list of blocks",
            "blocks": [
                "block_1_slug",
                "block_2_slug",
                "block_3_slug,
            ]
        }
    ]
}

The response contains the basic data for each block.

put/v3.0/boards/{boardSlug}/blocks/{blockSlug}/

Request

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

Path parameters

blockSlugstring required
boardSlugstring 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

formstring
positioninteger
titlestring nullable
location'left-sidebar' | 'right-sidebar' | 'header' | 'footer' | 'main' | 'non-primary'
colorstring nullable

color of block

configobject nullable
workspace_access'owner' | 'admin' | 'team_member' | 'guest'
access_settingsobject nullable
rolesinteger[]

roles that have access to this block.

Response

slugstring nullable
formstring
type'generic' | 'menu' | 'stats' | 'form_display' | 'form_result' | 'form_charts' | 'report' | 'kanban' | 'content' | 'ai_summary'
created_atstring date-time
updated_atstring date-time
positioninteger
titlestring nullable
location'left-sidebar' | 'right-sidebar' | 'header' | 'footer' | 'main' | 'non-primary'
colorstring nullable

color of block

configobject nullable
workspace_access'owner' | 'admin' | 'team_member' | 'guest'
access_settingsobject nullable
rolesinteger[]

roles that have access to this block.

Changes

No recorded changes to this operation across all 1 revision of this API.