Skip to main content
PATCH
/
tags
/
{slug}
Update a tag
curl --request PATCH \
  --url https://api.getfernand.com/tags/{slug} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Premium Customer",
  "color": "#00FF00"
}
'
{
  "id": 42,
  "slug": "important-customer",
  "name": "Important Customer",
  "color": "#FF5733",
  "count_conversations": 15,
  "is_system": false
}
Updates the name and/or color of an existing tag identified by its slug. If the name is changed, the slug will be automatically regenerated. System tags cannot be modified.

Authorizations

X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Path Parameters

slug
string
required

Slug of the tag to update

Body

application/json
name
string

New name for the tag

Maximum string length: 50
Example:

"Premium Customer"

color
string

New hex color code for the tag

Example:

"#00FF00"

Response

Tag updated successfully

id
integer<int32>
required

Unique identifier for the tag

Example:

42

slug
string
required

URL-friendly slug generated from the tag name

Maximum string length: 50
Example:

"important-customer"

name
string
required

Display name of the tag

Maximum string length: 50
Example:

"Important Customer"

color
string
required

Hex color code for the tag (e.g.,

Example:

"#FF5733"

count_conversations
integer<int32>
required

Number of conversations associated with this tag

Example:

15

is_system
boolean
required

Whether this is a system-defined tag that cannot be modified or deleted

Example:

false