Skip to main content
POST
Create a survey segment

Authorizations

Authorization
string
header
required

Bearer API key. Secret server keys start with gt_live_; client-safe browser keys start with gt_pub_ (write-only, origin-pinned). Create and scope keys in Settings → API Keys.

Body

application/json
name
string
required

Unique in the workspace, ignoring case.

Required string length: 1 - 120
rules
object
required

Who to reach: People who match person, at Companies that match company. An empty rules list in a group matches everyone for that group. A request needs at least one rule across both groups, so nobody is ever invited by accident. Only People with an email address at Companies that aren't archived can match.

Response

Segment saved.

data
object
required