PATCH
/
boards
/
{id}
curl --request PATCH \
  --url https://api.dock.so:4000/{version}/boards/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "Sales",
  "appearance": "greyExtraLight",
  "description": "Sales board",
  "tagIds": [
    "RiHO4e0Ju3DS"
  ],
  "tagNames": [
    "Sales"
  ],
  "icon": "🚀",
  "index": 0
}'
{
  "data": {
    "board": {
      "id": "RiHO4e0Ju3DS",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "object": "board",
      "url": "https://api.dock.us/v1/boards/RiHO4e0Ju3DS",
      "title": "Sales",
      "appearance": "greyExtraLight",
      "icon": "🚀",
      "description": "Sales leads",
      "tags": [
        {
          "id": "RiHO4e0Ju3DS",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "object": "tag",
          "url": "https://api.dock.us/v1/tags/RiHO4e0Ju3DS",
          "title": "Logo"
        }
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Unique identifier

Example:

"RiHO4e0Ju3DS"

Query Parameters

​
properties
enum<string>[]

Select the board properties that should be returned

Available options:
title,
appearance,
icon,
updatedAt,
description,
createdAt,
tags.title,
tags.createdAt,
tags.updatedAt

Body

application/json
Board to update
​
title
string

Title of the board

Minimum length: 1
Example:

"Sales"

​
appearance
enum<string>

Appearance of the board

Available options:
greyExtraLight,
mandy,
saffron,
conifer,
pastelGreen,
downy,
malibu,
royalBlue,
mediumPurple,
brilliantRose
Example:

"greyExtraLight"

​
description
string

Description of the board

Example:

"Sales board"

​
tagIds
string[]

IDs of the tags to associate with the board

Id of the object

​
tagNames
string[]

Names of the tags to associate with the board

Name of the tag

​
icon
string

Icon of the board

Example:

"🚀"

​
index
number

Index of the board

Example:

0

Response

200
application/json
Board updated
​
data
object