Skip to main content
The Segment API lets you create and manage Segments — a Segment is a dynamic, filtered view of one Audience (a saved filter condition evaluated over that audience’s contacts), or a static snapshot of a Campaign’s dialed contacts filtered the same way.
  • Use Create Segment to build a segment from an audience’s contacts or a campaign’s dial results.
  • Use Preview Segment to test filter conditions against an audience before saving.
  • Use List Segments to retrieve the paginated Segment tab.
  • Use Segment Summary List to get a lightweight id/name/count list for dropdowns.
  • Use Segment Details to retrieve one segment’s full configuration.
  • Use Update Segment to modify a segment, or soft-delete it.
  • Use List Segment Contacts to retrieve a segment’s contact list.
  • Use Export Segment Contacts to download a segment’s contacts as an Excel file.