CTRLK

Shared components

Manage segments over API

|

View as Markdown

You can manage segments programmatically through the Customer Profiles API.

Use the API to create, retrieve, update, and delete segments as part of your automated workflows. To manage segments through the web interface, see Create a segment and Manage segments.


Available operations

The following operations are available:

EndpointDescription
Create a segmentCreate a new segment.
Get segmentsGet all segments.
Get segmentGet a specific segment.
Update segmentUpdate a segment.
Delete segmentDelete a segment.
Get persons in a segmentGet persons in a segment by ID.

Use cases

Common use cases for managing segments through the API include:

  • Automated segment creation - Create segments based on external data sources or scheduled processes
  • Dynamic segment updates - Modify segment rules based on business logic or user behavior patterns
  • Integration workflows - Sync segments with external CRM or marketing automation platforms
  • Bulk operations - Manage multiple segments programmatically for large-scale campaigns

For detailed API documentation including request parameters, response formats, and code examples, see the Customer Profiles API documentation.