curl --request PUT \
--url https://api.getcargo.io/v1/segmentation/segments/{uuid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"sort": [
{
"columnSlug": "<string>"
}
],
"limit": 123,
"trackingColumnSlugs": [
"<string>"
],
"columnSlugs": [
"<string>"
]
}
'import requests
url = "https://api.getcargo.io/v1/segmentation/segments/{uuid}"
payload = {
"name": "<string>",
"sort": [{ "columnSlug": "<string>" }],
"limit": 123,
"trackingColumnSlugs": ["<string>"],
"columnSlugs": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
sort: [{columnSlug: '<string>'}],
limit: 123,
trackingColumnSlugs: ['<string>'],
columnSlugs: ['<string>']
})
};
fetch('https://api.getcargo.io/v1/segmentation/segments/{uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getcargo.io/v1/segmentation/segments/{uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'sort' => [
[
'columnSlug' => '<string>'
]
],
'limit' => 123,
'trackingColumnSlugs' => [
'<string>'
],
'columnSlugs' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getcargo.io/v1/segmentation/segments/{uuid}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"sort\": [\n {\n \"columnSlug\": \"<string>\"\n }\n ],\n \"limit\": 123,\n \"trackingColumnSlugs\": [\n \"<string>\"\n ],\n \"columnSlugs\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.getcargo.io/v1/segmentation/segments/{uuid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"sort\": [\n {\n \"columnSlug\": \"<string>\"\n }\n ],\n \"limit\": 123,\n \"trackingColumnSlugs\": [\n \"<string>\"\n ],\n \"columnSlugs\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/segmentation/segments/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"sort\": [\n {\n \"columnSlug\": \"<string>\"\n }\n ],\n \"limit\": 123,\n \"trackingColumnSlugs\": [\n \"<string>\"\n ],\n \"columnSlugs\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"segment": {
"uuid": "<string>",
"workspaceUuid": "<string>",
"userUuid": "<string>",
"modelUuid": "<string>",
"slug": "<string>",
"name": "<string>",
"filter": {
"conjonction": "or",
"groups": [
{
"conjonction": "or",
"conditions": [
{
"kind": "sql",
"name": "<string>",
"clause": "<string>"
}
]
}
]
},
"sort": [
{
"columnSlug": "<string>",
"kind": "asc"
}
],
"limit": 123,
"recordsCount": 123,
"fromPlay": true,
"trackingColumnSlugs": [
"<string>"
],
"columnSlugs": [
"<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>"
}
}
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}Update segment
Update a segment (PUT /segmentation/segments/).
curl --request PUT \
--url https://api.getcargo.io/v1/segmentation/segments/{uuid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"sort": [
{
"columnSlug": "<string>"
}
],
"limit": 123,
"trackingColumnSlugs": [
"<string>"
],
"columnSlugs": [
"<string>"
]
}
'import requests
url = "https://api.getcargo.io/v1/segmentation/segments/{uuid}"
payload = {
"name": "<string>",
"sort": [{ "columnSlug": "<string>" }],
"limit": 123,
"trackingColumnSlugs": ["<string>"],
"columnSlugs": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
sort: [{columnSlug: '<string>'}],
limit: 123,
trackingColumnSlugs: ['<string>'],
columnSlugs: ['<string>']
})
};
fetch('https://api.getcargo.io/v1/segmentation/segments/{uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getcargo.io/v1/segmentation/segments/{uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'sort' => [
[
'columnSlug' => '<string>'
]
],
'limit' => 123,
'trackingColumnSlugs' => [
'<string>'
],
'columnSlugs' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getcargo.io/v1/segmentation/segments/{uuid}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"sort\": [\n {\n \"columnSlug\": \"<string>\"\n }\n ],\n \"limit\": 123,\n \"trackingColumnSlugs\": [\n \"<string>\"\n ],\n \"columnSlugs\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.getcargo.io/v1/segmentation/segments/{uuid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"sort\": [\n {\n \"columnSlug\": \"<string>\"\n }\n ],\n \"limit\": 123,\n \"trackingColumnSlugs\": [\n \"<string>\"\n ],\n \"columnSlugs\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/segmentation/segments/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"sort\": [\n {\n \"columnSlug\": \"<string>\"\n }\n ],\n \"limit\": 123,\n \"trackingColumnSlugs\": [\n \"<string>\"\n ],\n \"columnSlugs\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"segment": {
"uuid": "<string>",
"workspaceUuid": "<string>",
"userUuid": "<string>",
"modelUuid": "<string>",
"slug": "<string>",
"name": "<string>",
"filter": {
"conjonction": "or",
"groups": [
{
"conjonction": "or",
"conditions": [
{
"kind": "sql",
"name": "<string>",
"clause": "<string>"
}
]
}
]
},
"sort": [
{
"columnSlug": "<string>",
"kind": "asc"
}
],
"limit": 123,
"recordsCount": 123,
"fromPlay": true,
"trackingColumnSlugs": [
"<string>"
],
"columnSlugs": [
"<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>"
}
}
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}Authorizations
API token from cargo-ai login. Send as Authorization: Bearer <token>.
Headers
Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.
255"8e03978e-40d5-43e8-bc93-6894a57f9324"
Path Parameters
Segment identifier.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$Body
Request body schema.
Segment name.
1 - 255Segment filter criteria.
Show child attributes
Show child attributes
Sort criteria for the segment.
Show child attributes
Show child attributes
Maximum number of records in the segment.
Tracking column identifiers.
Identifiers of the columns displayed for the segment.
Response
Update segment
Updated segment details.
Show child attributes
Show child attributes
Was this page helpful?

