v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-013593344.3 KB

Segments

Create Segment

Create a custom user segment based on filter rules. Available on all plans, limited by your plan's maxCustomSegments quota.

After creation, segment membership is computed asynchronously. The segment will be available immediately but member counts may take a few moments to populate.

post/segments

Request body

namestring

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

descriptionstring

A description of the segment purpose.

iconstring

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

Response

Segment created successfully

idstring uuid required

The created segment ID.

namestring required

The segment name.

type'custom' required

Always "custom" for API-created segments.

descriptionstring nullable required

Segment description.

iconstring nullable required

Icon identifier.

filtersobject required

The filter configuration.

createdAtstring date-time required

When the segment was created.

updatedAtstring date-time required

When the segment was last updated.