Segments API
Save a live filter on a contact book and read who matches it.
- GETList segments
/v1/contactBooks/{contactBookId}/segmentsList a contact book's segments, oldest first.
- POSTCreate a segment
/v1/contactBooks/{contactBookId}/segmentsCreate a live filter on a contact book.
- GETGet a segment
/v1/contactBooks/{contactBookId}/segments/{segmentId}Retrieve one segment with its definition, live count and problems.
- PATCHUpdate a segment
/v1/contactBooks/{contactBookId}/segments/{segmentId}Change a segment's name, description or definition.
- DELDelete a segment
/v1/contactBooks/{contactBookId}/segments/{segmentId}Delete a segment.
- GETList a segment's contacts
/v1/contactBooks/{contactBookId}/segments/{segmentId}/contactsPage through the contacts that match a segment right now, ordered by id.
- POSTPreview a segment
/v1/contactBooks/{contactBookId}/segments/previewThe live count for a segment definition without saving it: how many contacts match now, how many of those are subscribed (who a campaign would reach),…
- GETExport a segment as CSV
/v1/contactBooks/{contactBookId}/segments/{segmentId}/exportThe contacts matching a segment as CSV text, newest first, with the contact book's properties as columns.