Skip to main content
Conversation Tags

Create or rename a tag

Creates a new workspace conversation tag when only name is provided. If id is also provided, the existing tag is renamed instead.

POST
/v2/tags
Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-08-19.orbit

Body

application/json
actingAdminIdstring

Optional admin ID for actor attribution and permission checks.

Example: 507f1f77bcf86cd799439011
idstring

Optional existing tag ID. Provide this to rename an existing tag instead of creating a new one.

Example: 67ec1234abcd5678ef901234
namestringrequired

Tag name

Required string length: 1 - 255
Example: Churn

Response

application/json

Success

idstringrequired

Unique tag identifier

Example: 67ec1234abcd5678ef901234
namestringrequired

Current tag name

Example: Churn
typeenum<string>required

Object type identifier for a tag

Available options: tag
Example: tag