Sign in

v1

latestOpenAPI 3.0.02026-07-2664192238.8 KB
Segments

Update segment

Updates an existing segment by ID. The segment must not be in a building state to be updated. If the segment is currently being built, a 409 Conflict error is returned.

Scopes: segments.write

Rate Limiting: This endpoint is rate limited to 15 requests per minute.

The request body structure (name and conditionGroups) is identical to Create segment. See the Create segment endpoint for detailed examples of condition groups, filters, and advanced segmentation patterns.

put/segments/{segmentID}

Path parameters

segmentIDstring required

Segment ID

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Request body

namestring required

Name of the segment

Example request

{
  "conditionGroups": [
    {
      "conditions": [
        {
          "entity": "contact",
          "junction": "and"
        }
      ]
    }
  ],
  "name": "My Segment"
}

Response

OK

archivedAtstring nullable

Segment archival timestamp, null if not archived (read-only)

createdAtstring

Segment creation timestamp (read-only)

isStarredboolean

Whether the segment is marked as a favourite

namestring

Segment name

segmentIDstring

Segment unique identifier (read-only)

status'ready' | 'building' | 'archived'

Segment processing status (read-only)

updatedAtstring

Segment last update timestamp (read-only)

Example response

{
  "archivedAt": "2026-06-01T00:00:00Z",
  "conditionGroups": [
    {
      "conditions": [
        {
          "entity": "contact",
          "junction": "and"
        }
      ]
    }
  ],
  "createdAt": "2026-01-15T10:30:00Z",
  "name": "VIP Customers",
  "segmentID": "000000000000000000000001",
  "status": "ready",
  "updatedAt": "2026-01-20T14:45:00Z"
}