Skip to main content
PUT
/
segmentation
/
segments
/
{uuid}
Update segment
curl --request PUT \
  --url https://api.getcargo.io/v1/segmentation/segments/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "filter": {
    "conjonction": "or",
    "groups": [
      {}
    ]
  },
  "sort": [
    {
      "columnSlug": "<string>",
      "kind": "asc"
    }
  ],
  "limit": 123,
  "trackingColumnSlugs": [
    "<string>"
  ]
}
'
{
  "segment": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "userUuid": "<string>",
    "modelUuid": "<string>",
    "slug": "<string>",
    "name": "<string>",
    "filter": {
      "conjonction": "or",
      "groups": [
        {}
      ]
    },
    "sort": [
      {
        "columnSlug": "<string>",
        "kind": "asc"
      }
    ],
    "limit": 123,
    "recordsCount": 123,
    "fromPlay": true,
    "trackingColumnSlugs": [
      "<string>"
    ],
    "syncedAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "lastChange": {
      "uuid": "<string>",
      "slug": "<string>",
      "totalRecordsCount": 123,
      "updatedRecordsCount": 123,
      "removedRecordsCount": 123,
      "addedRecordsCount": 123,
      "unchangedRecordsCount": 123,
      "createdAt": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uuid
string
required

Resource UUID

Body

application/json

Request body schema.

name
string

Segment name.

filter
Filter · object

Segment filter criteria.

sort
Sort · object[] | null

Sort criteria for the segment.

limit
number | null

Maximum number of records in the segment.

trackingColumnSlugs
string[] | null

Tracking column identifiers.

Response

Successful response

segment
Segment · object
required

Updated segment details.