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).

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

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.

is_dynamic

boolean

Set to true to create a dynamic (query-driven) segment that auto-populates from the query filters. Set to false (or omit) for a static or behavior-based segment.

query

object

Dynamic segment query filters. Providing any subfield makes the segment dynamic and auto-populated.

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

201The created segment