v58

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-073053701.0 MB

Reach: Segments

Update a profile segment

Rename a segment and/or replace the conditions that define it.

name is always required. Omit conditions to rename without touching the conditions; supply them and they replace the existing set entirely rather than being merged into it. Contacts are never modified, but which of them match the segment can change immediately.

put/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}

Path parameters

profileUuidstring required

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

Profile uuid parameter

segmentUuidstring required

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

Segment uuid parameter

Request body

namestring required

logic'AND' | 'OR'

How to combine multiple conditions. Required when conditions are given.

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"
}