Skip to main content
POST
Create a tag

Authorizations

Authorization
string
header
required

OAuth 2.1 access token.

Body

application/json
name
string
required

Display name of the tag.

Required string length: 1 - 30
Example:

"Hot Lead"

key
string
required

Unique key within the workspace. Lowercase letters, digits, and underscores between words only. No spaces, accents, or other punctuation.

Required string length: 1 - 30
Pattern: ^[a-z0-9]+(_[a-z0-9]+)*$
Example:

"hot_lead"

color_text
string

Text color in hex RGB format (e.g. #ffffff). Omit to use the workspace default (#374152).

Pattern: ^#[0-9a-fA-F]{6}$
Example:

"#ffffff"

color_background
string

Background color in hex RGB format (e.g. #ef4444). Omit to use the workspace default (#e4e6eb).

Pattern: ^#[0-9a-fA-F]{6}$
Example:

"#ef4444"

Response

Tag created successfully.

data
object