Segments API
7 endpoints. All requests need an Authorization header — see Authentication. API keys additionally need the matching scope.
| Method | Path | Description |
|---|---|---|
GET |
/api/segments |
List Segments Query: object_type. |
POST |
/api/segments |
Create Segment Accepts a JSON body. |
POST |
/api/segments/preview |
Preview Accepts a JSON body. |
PATCH |
/api/segments/{segment_id} |
Update Segment Accepts a JSON body. |
DELETE |
/api/segments/{segment_id} |
Delete Segment |
POST |
/api/segments/{segment_id}/enroll |
Enroll Segment Accepts a JSON body. |
GET |
/api/segments/{segment_id}/members |
Segment Members Query: limit. |
Try it
The full request/response schema for every endpoint is in the OpenAPI spec served by your own workspace.