[Go to site: main page, start]

Skip to main content
POST
Create an audience segment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

The name of the audience segment. Must be unique within the team.

Maximum string length: 255
Example:

"Active users"

filter
object
required

A tree of audience conditions combined with match.

description
string

An optional description of the audience segment.

Maximum string length: 1000

Response

Audience segment created.

id
string
required

The ID of the audience segment.

Example:

"cls6e8g0i2k4m6o8q0s2u4w6"

name
string
required

The name of the audience segment.

Example:

"Power users"

description
string | null
required

An optional description of the audience segment.

Example:

"Contacts on the pro plan"

createdAt
string
required

ISO 8601 timestamp for when the audience segment was created.

Example:

"2025-06-29T07:47:39.370Z"

updatedAt
string
required

ISO 8601 timestamp for when the audience segment was last updated.

Example:

"2025-06-29T07:47:39.370Z"

filter
object | null
required

A tree of audience conditions combined with match.

Last modified on August 3, 2026