Skip to main content

Create a CRM segment

POST 
/v1/segments

Create a segment.

name, entity_type (contact, company or deal) and filter_config are required; description, segment_type, is_public and tags are optional. filter_config uses the same structure as the in-product Filter Builder, so preview it first with POST /v1/segments/preview to check it matches what you expect.

The segment is created in pending state with no member count — call evaluate to compute one. Requires the segments:write scope.

Request​

Responses​

Successful Response

Last updated on