Voice AgentsBoards

Create board

View as Markdown
Creates an empty board with one default tab.

Path parameters

org_idstringRequired
Organization ID
workspace_idstringRequired
Workspace ID

Headers

X-API-KeystringRequired
Your workspace API key.

Request

This endpoint expects an object.
namestringRequired4-80 characters
Board display name, unique within the workspace
tagstring or nullOptional4-80 characters

Optional grouping label. A board carries at most one tag, and tags are not stored objects: a tag exists while at least one board uses it and disappears when the last one stops. Omit or send null to leave the board untagged.

Response

Successful Response
idstringformat: "uuid"

Board identifier, used as {board_id} in every nested route

namestring
Board display name
created_byobject
Actor that created the board
created_atdatetime
Creation time, UTC, RFC 3339
updated_byobject
Actor that last changed the board or anything on it
updated_atdatetime
Last change time, UTC, RFC 3339
tagstring or nullOptional
The board's grouping tag, or null when untagged

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error