Skip to main content
POST
/
conversations
/
{id}
/
tags
Add a tag to a conversation
curl --request POST \
  --url https://api.getfernand.com/conversations/{id}/tags \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "urgent"
}
'
{
  "id": 42,
  "slug": "important-customer",
  "name": "Important Customer",
  "color": "#FF5733",
  "count_conversations": 15,
  "is_system": false
}
Associates an existing tag with a conversation, or creates a new tag if it doesn’t exist. Tags help categorize and filter conversations. If the tag already exists on the conversation, nothing will be done.

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

id
integer<int64>
required

ID of the conversation to tag.

Body

application/json
name
string
required

Name of the tag to add. Will be created if it doesn't exist.

Maximum string length: 50
Example:

"urgent"

Response

Tag added 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