Segments

Saved lists of contacts, to aim a broadcast or an assistant trigger at.

The segment object

As returned by GET /segments, one element of the list. Every endpoint below that returns this resource returns exactly these fields.

Name	Type	Description
`id`required	`string (uuid)`	UUID
`name`required	`string`	The segment’s name
`description`required	`string \| null`	What the segment is for
`color`required	`string`	Hex colour used for the segment in the dashboard
`member_count`required	`integer`	How many contacts are in the segment. Counts contacts on a member’s private number too, which the API never lists, so it can be higher than the contacts you can page through
`created_at`required	`string (date-time)`	ISO 8601 timestamp
`updated_at`required	`string (date-time)`	ISO 8601 timestamp

8 endpoints, each on its own page with its parameters, responses, error codes and samples in curl, Node and Python.