Skip to main content

Segments

Contact segments (audiences). Used by campaigns as the recipient set.

GET /v1/segments

List segments Lists contact segments (audiences), ordered by name. Used by campaigns as the recipient set.

Examples

200 — OK

cURL

POST /v1/segments

Create segment Creates a segment with a non-empty name.

Request body — Body

Examples

201 — Created

cURL

GET /v1/segments/{id}

Get segment Fetch one segment.

Examples

200 — OK

cURL

PATCH /v1/segments/{id}

Update segment Body must include a non-empty name.

Request body — Body

Examples

200 — OK

cURL

DELETE /v1/segments/{id}

Delete segment Deletes the segment. Contacts are not deleted.

Examples

200 — OK

cURL