Update a segment

PUT/cdp/{connection_id}/segment/{id}

Parameters

Payload

idstring

Unique identifier for this segment object

created_atdate-time

The date that this segment object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate-time

The last date that this segment object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

The name of the segment/audience

slugstring

The data-plane handle/key used to identify segment membership in profiles and destinations

descriptionstring

The description of the segment/audience

definitionstring

The membership rule/query that defines the segment

type enum

Valid values:

"USERS"

"ACCOUNTS"

"LINKED"

The type of entity the segment targets (USERS, ACCOUNTS, LINKED)

compute_mode enum

Valid values:

"REALTIME"

"BATCH"

How the segment membership is computed (REALTIME or BATCH)

sizenumber

The number of profiles currently in the segment

is_activeboolean

Whether the segment is active/enabled

source_idstring

The cdp_source this segment originated from; points to CdpSource

raw

The raw data returned by the integration for this segment

Returns

CdpSegment

Response field	Type	Required	Description
`id`	string	No	Unique identifier for this segment object
`created_at`	string (date-time)	No	The date that this segment object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	The last date that this segment object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`name`	string	No	The name of the segment/audience
`slug`	string	No	The data-plane handle/key used to identify segment membership in profiles and destinations
`description`	string	No	The description of the segment/audience
`definition`	string	No	The membership rule/query that defines the segment
`type`	enum	No	The type of entity the segment targets (USERS, ACCOUNTS, LINKED) Values: `USERS`, `ACCOUNTS`, `LINKED`
`compute_mode`	enum	No	How the segment membership is computed (REALTIME or BATCH) Values: `REALTIME`, `BATCH`
`size`	number	No	The number of profiles currently in the segment
`is_active`	boolean	No	Whether the segment is active/enabled
`source_id`	string	No	The cdp_source this segment originated from; points to CdpSource

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'PUT',
  url: 'https://api.unified.to/cdp/5de520f96e439b002043d8dc/segment/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.cdp.updateCdpSegment({ connectionId, id, cdpSegment: { }, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'PUT',
  url: 'https://api.unified.to/cdp/5de520f96e439b002043d8dc/segment/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("PUT", "https://api.unified.to/cdp/5de520f96e439b002043d8dc/segment/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/cdp/5de520f96e439b002043d8dc/segment/5de520f96e439b002043d8d8?fields=&raw=

req, _ := http.NewRequest("PUT", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/cdp/5de520f96e439b002043d8dc/segment/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.put(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/cdp/5de520f96e439b002043d8dc/segment/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/cdp/5de520f96e439b002043d8dc/segment/5de520f96e439b002043d8d8?fields=&raw=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body

cURL

curl --request PUT \
  --url 'https://api.unified.to/cdp/5de520f96e439b002043d8dc/segment/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?