Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Body

application/json
filters
object
required

Filter configuration defining segment membership.

name
string

Segment name. If omitted, an auto-generated name will be assigned.

Maximum string length: 255
description
string

A description of the segment purpose.

icon
string

Icon identifier for the segment (e.g. "Users", "Tag").

Maximum string length: 50

Response

Segment created successfully

id
string<uuid>
required

The created segment ID.

name
string
required

The segment name.

type
enum<string>
required

Always "custom" for API-created segments.

Available options:
custom
description
string | null
required

Segment description.

icon
string | null
required

Icon identifier.

filters
object
required

The filter configuration.

createdAt
string<date-time>
required

When the segment was created.

updatedAt
string<date-time>
required

When the segment was last updated.