boards

Board Action

patch/v3.0/boards/{boardSlug}/

Request

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

Path parameters

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

blocksobject

A dictionary of block locations and slug of the blocks in each location.

templatestring

user_formstring nullable

copied_fromstring

thumbnail_slugstring nullable

tagsstring[]

tags's slug.

folderstring nullable

refresh_share_addressboolean

If set true, the board's share address will be replaced by a new automatically generated address. This change is irreversible.

banner_slugstring nullable

logo_slugstring nullable

icon_slugstring nullable

is_publicboolean

shows if this board can be displayed publicly.

is_templateboolean

shows if this board can be used as a template.

template_type'board' | 'form'

titlestring nullable

an optional short title to identify the board by.

descriptionstring nullable

an optional description on the board.

share_addressstring nullable

an auto-generated address to share the board with.

configobject nullable

theme_configobject nullable

custom_domainstring nullable

user can set this on the board, if they want to show this board on a custom domain (e.g. https://example.co/).

custom_cssstring nullable

enter custom css to be applied to board. this CSS will not be sanitized.

custom_jsstring nullable

enter custom js to be run in board. this js will not be sanitized.

Response

blocksobject

A dictionary of block locations and slug of the blocks in each location.

templatestring

user_formstring nullable

copied_fromstring

tagsstring[]

tags's slug.

pinnedboolean

shows if the board is pinned by the current user.

excerptstring nullable

an optional excerpt on the board to be searched on.

folderstring nullable

is_sharedboolean

shows if the board is shared by the current user or user is the owner.

white_labelstring

full_board_addressstring

form_visit_countstring

shows the visit count of the board's main form if it has exactly one form.

form_submit_countstring

shows the submit count of the board's main form if it has exactly one form.

refresh_share_addressboolean

If set true, the board's share address will be replaced by a new automatically generated address. This change is irreversible.

thumbnail_urlstring

banner_urlstring

logo_urlstring

icon_urlstring

created_atstring date-time

updated_atstring date-time

slugstring

is_primaryboolean

shows if this board is the primary board for the primary form.