Create segment

Creates a new segment on the specified newsletter list.

Required Fields

  • name — the display name of the segment

Optional Fields

  • description — internal description
  • backgroundColor — hex color code (e.g. #ffc1d8) shown in the segment list
  • conditions — filter rules (groups + groupOperators structure). If omitted, the segment matches all subscribers.

Conditions Format

Pass a conditions object with groups (array of condition groups) and groupOperators (array of AND/OR connectors between groups).
See the SegmentConditions schema for the full structure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Newsletter (list) ID where the segment will be created

Body Params
string
required

Display name of the segment

string

Optional internal description

string

Background color in #RRGGBB hex format

string
enum
Defaults to all

Which subscribers the segment holds by their status

Allowed:
boolean
Defaults to true

Count an e-mail address that is on the list several times only once

integer

The segment group to put the new segment into (see GET /newsletter/{newsletterId}/segment-groups). Required when the list has segment groups.

conditions
object

The filter rules of the segment expressed as groups of conditions

Responses

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