PATCH
/
tags
/
{id}
curl --request PATCH \
  --url https://api.dock.so:4000/{version}/tags/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "Sales",
  "boardIds": [
    "RiHO4e0Ju3DS"
  ]
}'
{
  "data": {
    "tag": {
      "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",
      "boards": [
        {
          "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"
        }
      ]
    }
  }
}

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 tag properties that should be returned

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

Body

application/json
Tag to update
​
title
string

Title of the tag

Minimum length: 1
Example:

"Sales"

​
boardIds
string[]

IDs of the boards to associate with the tag

Id of the object

Response

200
application/json
Tag updated
​
data
object