---
title: "Update segment"
method: PUT
path: "/segmentation/segments/{uuid}"
tags: ["Segmentation - Segments"]
---

# Update segment

`PUT /segmentation/segments/{uuid}`

Update a segment

## Path parameters

- `uuid` string, uuid, required — Segment identifier.

## Request body

- object — Request body schema.
  - `name` string — Segment name.
  - `filter` object — Segment filter criteria.
    - `conjonction` 'or' | 'and', required
    - `groups` object[], required
      - `conjonction` 'or' | 'and', required
      - `conditions` union[], required
        - union
          - object
            - `kind` 'sql', required
            - `name` string, required
            - `clause` string, required
          - object
            - `kind` 'string', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `operator` 'is' | 'isNot' | 'contains' | 'doesNotContain' | 'startsWith' | 'endsWith', required
            - `values` union, required
              - …
          - object
            - `kind` 'string', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `operator` 'isNull' | 'isNotNull' | 'isEmpty' | 'isNotEmpty', required
          - object
            - `kind` 'number', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `operator` 'is' | 'isNot' | 'greaterThan' | 'lowerThan', required
            - `value` number, required
          - object
            - `kind` 'number', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `operator` 'between', required
            - `firstValue` number, required
            - `lastValue` number, required
          - object
            - `kind` 'number', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `operator` 'isNull' | 'isNotNull', required
          - object
            - `kind` 'objectProperty', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `propertyName` string, required
            - `operator` 'is' | 'isNot' | 'contains' | 'greaterThan' | 'lowerThan' | 'doesNotContain' | 'startsWith' | 'endsWith', required
            - `value` string, required
          - object
            - `kind` 'objectProperty', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `propertyName` string, required
            - `operator` 'isNull' | 'isNotNull' | 'isEmpty' | 'isNotEmpty', required
          - object
            - `kind` 'objectProperty', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `propertyName` string, required
            - `operator` 'between', required
            - `value` string, required
            - `otherValue` string, required
          - object
            - `kind` 'object', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `operator` 'isNull', required
          - object
            - `kind` 'object', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `operator` 'isNotNull', required
          - object
            - `kind` 'object', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `operator` 'matchConditions', required
            - `conjonction` 'or' | 'and', required
            - `propertyConditions` union[], required
              - …
          - object
            - `kind` 'array', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `operator` 'isNull', required
          - object
            - `kind` 'array', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `operator` 'isNotNull', required
          - object
            - `kind` 'array', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `operator` 'matchConditions', required
            - `conjonction` 'or' | 'and', required
            - `propertyConditions` union[], required
              - …
          - object
            - `kind` 'any', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `operator` 'isNull' | 'isNotNull', required
          - object
            - `kind` 'vector', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `operator` 'isNull' | 'isNotNull', required
          - object
            - `kind` 'date', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `operator` 'is' | 'isNot' | 'greaterThan' | 'lowerThan', required
            - `value` string, required
          - object
            - `kind` 'date', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `operator` 'between', required
            - `firstValue` string, required
            - `lastValue` string, required
          - object
            - `kind` 'date', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `operator` 'isNull' | 'isNotNull', required
          - object
            - `kind` 'boolean', required
            - `relatedModelUuid` string
            - `columnSlug` string, required
            - `operator` 'isTrue' | 'isFalse' | 'isNull' | 'isNotNull', required
          - object
            - `kind` 'occurrence', required
            - `relatedModelUuid` string, required
            - `frequency` union, required
              - …
            - `period` object, required
              - …
            - `conjonction` 'or' | 'and', required
            - `conditions` union[], required
              - …
          - object
            - `kind` 'enrollment', required
            - `workflowUuid` string, required
            - `activityKind` 'workflowEntered' | 'workflowNodeExecuted' | 'workflowLeft', required
            - `nodeSlug` string
            - `frequency` union, required
              - …
            - `period` object, required
              - …
          - object
            - `kind` 'segment', required
            - `segmentUuid` string, required
            - `operator` 'in' | 'notIn', required
  - `sort` object[], nullable — Sort criteria for the segment.
    - `columnSlug` string, required
    - `kind` 'asc' | 'desc', required
  - `limit` number, nullable — Maximum number of records in the segment.
  - `trackingColumnSlugs` string[], nullable — Tracking column identifiers.
  - `columnSlugs` string[], nullable — Identifiers of the columns displayed for the segment.

## Response `200`

Successful response

- object
  - `segment` object, required — Updated segment details.
    - `uuid` string, required
    - `workspaceUuid` string, required
    - `userUuid` string, required
    - `modelUuid` string, required
    - `slug` string, required
    - `name` string, required
    - `filter` object, required
      - `conjonction` 'or' | 'and', required
      - `groups` object[], required
        - `conjonction` 'or' | 'and', required
        - `conditions` union[], required
          - union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
    - `sort` object[], nullable, required
      - `columnSlug` string, required
      - `kind` 'asc' | 'desc', required
    - `limit` number, nullable, required
    - `recordsCount` number, required
    - `fromPlay` boolean, required
    - `trackingColumnSlugs` string[], nullable, required
    - `columnSlugs` string[], nullable, required
    - `syncedAt` string, nullable, required
    - `createdAt` string, required
    - `updatedAt` string, required
    - `deletedAt` string, nullable, required
    - `lastChange` object, nullable, required
      - `uuid` string, required
      - `slug` string, required
      - `totalRecordsCount` number, required
      - `updatedRecordsCount` number, required
      - `removedRecordsCount` number, required
      - `addedRecordsCount` number, required
      - `unchangedRecordsCount` number, required
      - `createdAt` string, required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.net/getcargo/apis/cargo-api.md) · [All operations](https://skmtc.net/getcargo/apis/cargo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getcargo/cargo-api/revisions/1d5a19e01d83/schema)