Skip to main content
POST
/
tags
Create a new tag
curl --request POST \
  --url https://api.getfernand.com/tags \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "VIP Customer"
}
'
{
  "id": 42,
  "slug": "important-customer",
  "name": "Important Customer",
  "color": "#FF5733",
  "count_conversations": 15,
  "is_system": false
}
Creates a new tag with the specified name and optional color. The slug is automatically generated from the name. If no color is provided, a default gray color (#BEC2C8) is assigned. The tag name must be unique within the organization.

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.

Body

application/json
​
name
string
required

Name of the tag

Maximum string length: 50
Example:

"VIP Customer"

​
color
string

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

Pattern: ^#[0-9A-Fa-f]{6}$
Example:

"#FF5733"

Response

Tag created 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.,

Pattern: ^#[0-9A-Fa-f]{6}$
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