Skip to main content
POST
Create tag

Authorizations

Authorization
string
header
required

API key created in the organization settings.

Headers

Idempotency-Key
string

Unique key for the operation. Repeating the same key with the same body returns the original response instead of running it again.

Body

application/json
name
string
required

Tag name, unique in the store.

Required string length: 1 - 256
color
string
default:9CA3AF

6-digit hex color, such as 9CA3AF.

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

Optional unique id for this call, such as a UUID. Reuse the same value only to retry the same call: the retry returns the first result instead of creating again. The same value with a different body is rejected with 409.

Required string length: 8 - 128

Response

Tag created.

object
string
required
Allowed value: "tag"
id
string
required
Pattern: ^tag_[A-Za-z0-9_-]+$
name
string
required
color
string
required
created_at
string<date-time>
required