Skip to main content
POST
Create a segment
Create a segment defined by condition groups (conditions within a group are joined by OR; groups are joined by AND). Requires the audience:write scope and is blocked for sandbox API keys.

Authorizations

Authorization
string
header
required

API key for authentication

Body

application/json
name
string
required
Maximum string length: 255
Example:

"Engaged subscribers"

conditions
object
required
list_id
string<uuid> | null

Restrict segment to a single list. Must belong to the authenticated team.

Response

Segment created

message
string
required
Example:

"Segment retrieved successfully."

data
object
required