Skip to main content
POST
Create a segment

Authorizations

Authorization
string
header
required

Your API key (as_live_…), created under Settings → API keys.

Body

application/json
name
string
required

Name for the segment.

Example:

"Clicked, not converted (14d)"

definition
object
required

The rule set (see SegmentDefinition).

Example:
description
string

Optional description.

accept_orphans
boolean

Include contacts who are on no list.

Example:

true

Response

One segment.

ok
boolean
Example:

true

segment
object

A saved, rule-based audience.