Update a segment
PUT/cdp/{connection_id}/segment/{id}
Parameters
fieldsstring array
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
connection_idstring required
ID of the connection
idstring required
ID of the Segment
Payload
idstring
Unique identifier for this segment object
created_atdate
The date that this segment object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
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
Returns
idstring
Unique identifier for this segment object
created_atdate
The date that this segment object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
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
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); Are we missing anything? Let us know