Skip to main content
PUT
Update board

Authorizations

Authorization
string
header
required

API token in the sk_live_… format.

Path Parameters

boardId
integer
required

Body

application/json
name
string

Board name.

Example:

"Pós-venda"

description
string

Board description.

monthlyGoal
number

The board's monthly sales goal, used in the dashboards.

Example:

100000

yearlyGoal
number

The board's yearly sales goal, used in the dashboards.

Example:

1200000

Response

OK

data
object

CRM board, where cards move through the stages.

Who sees the board, and whether they see all cards or only their own, is set in each user's profile (Settings → Profiles), together with the queues linked to the board. The API token sees every board in the company.

Example: