Skip to main content
PATCH
/
tags
/
{tagId}
Update a tag
curl --request PATCH \
  --url https://alfaone.app/api/v1/tags/{tagId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "color": "#6366f1",
  "description": "<string>"
}
'
{
  "tag": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "color": "#6366f1",
    "description": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Format: ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Path Parameters

​
tagId
string<uuid>
required

Unique identifier of the tag

Body

application/json

At least one field must be provided.

​
name
string

New name for the tag (must be unique within the organization)

​
color
string

New hex color code for the tag

Example:

"#6366f1"

​
description
string | null

New description for the tag (set to null to clear)

Response

Tag updated successfully

​
tag
object