Skip to main content
POST
Create tag

Authorizations

Authorization
string
header
required

An API key (annie-sk-v2-...) or an OAuth access token, sent as Authorization: Bearer <token>.

Path Parameters

orgId
string<uuid>
required

The ID of the parent organization that owns the tags

Body

Payload required to create a conversation tag

name
string
required

Name of the tag. Must be unique within the organization.

Required string length: 1 - 100
Pattern: \S
classificationPrompt
string
required

Describes when this tag applies. At the end of each conversation, Annie checks the conversation against this text. Say what counts and what does not.

Required string length: 1 - 1000
Pattern: \S
direction
enum<string>
required
Available options:
INBOUND,
OUTBOUND,
BOTH
displayName
string

Label to show for this tag. Defaults to name.

Required string length: 1 - 100
Pattern: \S
color
enum<string>
Available options:
gray,
success,
warn,
error

Response

Response returned for a single tag

success
enum<boolean>
required
Available options:
true
data
object
required

A tag Annie can apply to a conversation when it ends