cdp

segment

Update a segment

patch/cdp/{connection_id}/segment/{id}

Request

Base URL: http://api.unified.to
URL: http://api.unified.to/cdp/{connection_id}/segment/{id}
Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Segment

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring

Unique identifier for this segment object

created_atstring date-time

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

updated_atstring date-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'USERS' | 'ACCOUNTS' | 'LINKED'

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

compute_mode'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

rawunknown

Response

Successful