Skip to main content
POST
Create segment

Authorizations

Authorization
string
header
required

API key authentication. Use your API key as the bearer token.

Body

application/json
name
string
required
Minimum string length: 1
Example:

"Active Users"

description
string
Example:

"Users who opened an email in the last 30 days"

type
enum<string>
default:manual

Segment type: 'manual' for static segments, 'data_driven' for dynamic filter-based segments

Available options:
manual,
data_driven
Example:

"data_driven"

conditions
object

Filter conditions for data-driven segments. Required when type is 'data_driven'.

Example:
tags
string[]

Tags for categorization. Lowercase, max 50 chars each, max 20 tags.

Example:

Response

Segment created

id
string<uuid>
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

organization_id
string<uuid>
required
name
string
required
description
string | null
required
type
enum<string>
required

Segment type: 'manual' or 'data_driven'

Available options:
manual,
data_driven
Example:

"data_driven"

conditions
object
required
tags
string[]
required

Tags for categorization.

Example:
created_by
string<uuid> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required