Boards

Create a board

POST/api/boards

Creates a board with a name, type, and configuration, optionally assigned to a team. Validates access to its referenced resources and reports.

Try it

Headers

Name	Type	Description
Authorizationrequired	string	Token returned by POST /api/auth/login, or an API key (`umami_…`) created under Settings → API keys (self-hosted only). `Bearer <token>`.
x-umami-share-contextrequired	string	Required context header when authenticating with a share token. `<api-key>`.
x-umami-share-tokenrequired	string	Signed token returned by a share endpoint. `<api-key>`.

Request body

Name	Type	Description
description	string	Description of the resource.
namerequired	string	Display name of the resource.
parameters	object	Configuration parameters for the resource.

teamId	string \| null	ID of the associated team.
typerequired	anyOf

userId	string \| null	ID of the associated user.

Example request

{
  "description": "string",
  "name": "string",
  "parameters": {
    "linkId": "123e4567-e89b-12d3-a456-426614174000",
    "pixelId": "123e4567-e89b-12d3-a456-426614174000",
    "websiteId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "teamId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "string",
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}

Responses

200The operation completed successfully.

Name	Type	Description
createdAtrequired	string	Date and time the record was created.
descriptionrequired	string	Description of the resource.
idrequired	string	Unique identifier of the resource.
namerequired	string	Display name of the resource.
parametersrequired	anyOf	Configuration parameters for the resource.

teamIdrequired	string	ID of the associated team.
typerequired	string
updatedAtrequired	string	Date and time the record was last updated.
userIdrequired	string	ID of the associated user.

200 example

{
  "createdAt": "2024-01-15T09:30:00Z",
  "description": "string",
  "id": "string",
  "name": "string",
  "parameters": "string",
  "teamId": "string",
  "type": "string",
  "updatedAt": "2024-01-15T09:30:00Z",
  "userId": "string"
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

Code samples

cURL

curl -X POST 'https://api.example.com/api/boards' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-umami-share-context: <api-key>' \
  -H 'x-umami-share-token: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "string",
  "name": "string",
  "parameters": {
    "linkId": "123e4567-e89b-12d3-a456-426614174000",
    "pixelId": "123e4567-e89b-12d3-a456-426614174000",
    "websiteId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "teamId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "string",
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}'

PreviousClone a board NextCreate a share for a board