Skip to main content
POST
Create a tag

Authorizations

Authorization
string
header
required

A workspace API token (sk_live_...) or an OAuth access token (oat_live_...). Create workspace tokens in Settings > API. Send either as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

A unique value (a UUID works) that makes retrying this request safe. A repeat with the same key and body within 24 hours returns the original response instead of acting twice; the same key with a different body is a 409 idempotency_key_reused.

Maximum string length: 255

Body

application/json

Body for POST /v1/tags.

name
string
required

Unique within the resource's catalogue.

Required string length: 1 - 100
resource
enum<string>
required

Which catalogue the tag belongs to. A tag can only be applied to records of this resource.

Available options:
contact,
organization,
deal
color
string
default:#6B7280

Hex colour used by the Sailer UI, e.g. #FFAA00.

Pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

Response

Successful Response

A CRM label. The catalogue is per entity type.

id
string
required

Unique identifier for a tag.

Pattern: ^tag_[0-9a-f]{32}$
Example:

"tag_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

name
string
required
color
string | null

Hex colour used by the Sailer UI, e.g. #FFAA00.

object
string
default:tag
Allowed value: "tag"