Sign in

v58

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-073053701.0 MB
Reach: Segments

Create a profile segment

Create a segment in a profile.

A segment is a saved set of conditions rather than a fixed list, so its membership changes as contacts change. Creating one does not modify any contact.

post/api/reach/v1/profiles/{profileUuid}/segmentation/segments

Path parameters

profileUuidstring required
Example:550e8400-e09b-41d4-a716-400055000000

Profile uuid parameter

Request body

namestring required
logic'AND' | 'OR' required

How to combine multiple conditions

Example request

{
  "name": "VIP Customers",
  "conditions": [
    {
      "attribute": "email",
      "operator": "equals",
      "value": "example@example.com"
    }
  ],
  "logic": "AND"
}

Response

Success response

uuidstring
namestring
created_atstring date-time
updated_atstring date-time

Example response

{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Segment name",
  "created_at": "2025-02-27T11:54:22Z",
  "updated_at": "2025-02-27T11:54:22Z"
}