v51

OpenAPI 3.0.0raw.githubusercontent.com2026-08-01267339950.6 KB

Reach: Segments

Create a new contact segment

Create a new contact segment.

This endpoint allows creating a new contact segment that can be used to organize contacts. The segment can be configured with specific criteria like email, name, subscription status, etc.

post/api/reach/v1/segmentation/segments

Request body

namestring required

logic'AND' | 'OR' required

Example request

{
  "name": "New segment name",
  "conditions": [
    {
      "operator": "equals",
      "value": "example@example.com",
      "attribute": "note"
    }
  ],
  "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"
}