Create Segment

post

https://{APP_DOMAIN}/api/3.2/messages/segments

Creates an email list segment for targeting messages. Can create static segments, behavior-based segments (from message opens/clicks/bounces), or dynamic segments (auto-populated from query rules). AI/MCP clients creating dynamic segment query payloads should call get_schema with type=segments once first.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

The segment name.

description

string

required

The segment description.

behavior

string

enum

Creates a behavior-based segment derived from a source message. Requires message_id to also be set.

Allowed:

message_id

integer

The message ID to create a segment from.

publication_id

integer

required

The publication to associate the segment with.

redirect_url

string

The URL that is used to redirect a subscriber after they are added to a segment.

auto_responder_id

integer

The template to send to a subscriber after they are added to the segment.

query

object

Dynamic segment builder query object. Before setting this field, fetch GET /schema?type=segments and build the object from the returned query_shape and rules. Passing query creates a dynamic, auto-populated segment.

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

201The created segment