Save a board. Creates a board when id is omitted, or updates the board with that id (only the fields you pass change). Public boards (Everyone in the app) appear on the portal; private ones (Team only) only to the team; custom ones (Limited) to the team and end users matching access_rules (identified users, segments, verified email domains or invited emails). anonymize_users hides customers' names from other customers. The slug becomes the portal URL and defaults to one made from the name. Pass idempotency_key when creating so a retry doesn't make a second board. Managers and owners. Nobody is emailed.
Toolset
admin
Who can call it
OwnersManagersAPI keys
REST
POST /api/v1/w/{workspace}/boards
Behavior
changes dataaccepts idempotency_key
Input
Field
Type
Description
id
string
Omit to create a board; pass to update that board.
name
string
Required to create.
slug
string
description
string or null
access
one of: public, private, custom
public (default; Everyone in the app): on the portal. private (Team only): team members only. custom (Limited): the team plus end users matching access_rules.
access_rules
object
Who may see a custom board; an end user matching any rule gets in. Lists you pass replace the current ones; omitted lists stay.
posting_enabled
boolean
Whether end users can submit posts (default true).
voting_enabled
boolean
Whether end users can vote (default true). The team can still add votes.
anonymize_users
boolean
Show customers to other customers as stable aliases (default false).
create_form
object
Wording on the public post form: title_label, title_placeholder, details_label, details_placeholder, button_label. Fields you pass change; null restores the default.
require_moderation
boolean
Hold end users' new posts for review before others see them (default false).
form_fields
array of string
Public post fields (keys or IDs) on the board's submit form, in order, at most 5; [] removes them all.
position
integer
Where to place it, from 0 (first). Others shift to make room. Omit to keep it.
expected_version
integer
The board's version from your last read. If it changed since, the call fails instead of overwriting a newer change.
idempotency_key
string
Retry-safe key. Repeating a call with the same key returns the first result.
Output
Field
Type
Description
idrequired
string
ID with prefix "brd_"
workspace_idrequired
string
ID with prefix "ws_"
slugrequired
string
namerequired
string
descriptionrequired
string or null
accessrequired
one of: public, private, custom
public (Everyone in the app): anyone can see it on the portal. private (Team only): team members only. custom (Limited): the team plus end users matching access_rules.
posting_enabledrequired
boolean
Whether end users can submit posts to this board.
voting_enabledrequired
boolean
Whether end users can vote on this board's posts.
create_formrequired
object
Labels and placeholders on the public post form.
anonymize_usersrequired
boolean
End users see other customers under stable aliases ("Anonymous Otter"); the team sees real names.
require_moderationrequired
boolean
End users' new posts wait for the team's approval before others see them.
positionrequired
integer
Order on the portal and in admin, from 0.
versionrequired
integer
created_atrequired
string (date-time)
updated_atrequired
string (date-time)
access_rulesrequired
object or null
For custom boards, who may see it; null for other boards and for end users.
form_fieldsrequired
array of object
Custom fields on the board's public post form, in order (create_post fields).