Create segment

This endpoint creates a segment model.

You need the "Create and update segments" permission to use this endpoint.

Body Params
string
required
length between 0 and 100

Name of the segment. Must be unique within the account, ignoring case. At most 100 characters.

string
enum
required

Type of customer the segment applies to. Only customers of this type are evaluated against the segment. Cannot be changed after creation.

Allowed:
specification
required

A node of a segment specification, written as an object with a single key naming the operator. Conditional operators (and, or) combine other operators and can be nested at most two levels deep; comparison operators compare one customer attribute against the given values. Use GET /v2/segments/attributes to find the attributes and operators supported for each segment type.

string | null

Human-readable summary of the segment's rules. At most 1000 characters.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json