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.

name
string
required

The name of the audience segment.

description
string | null
required

An optional description of the audience segment.

createdAt
string
required

ISO 8601 timestamp for when the audience segment was created.

updatedAt
string
required

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

filter
object | null
required

A tree of audience conditions combined with match.

Last modified on July 22, 2026