Create Auto Selected Segment

Creates an auto selected segment with automatic population rules. Optionally links to a message type and publication.

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

Body Params

integer
required

The ID of the segment to auto-select

boolean
required

Whether this segment is included (true) or excluded (false) from sends

integer

The ID of the message type this rule applies to

integer

The ID of the publication this rule applies to

string
enum

The renewal cohort to scope this rule to. Only used when the message type is 'email-renewal'. Common values: 'active', 'expired'.

Allowed:
tag_ids
array of integers

Message tag IDs this rule is scoped to. The rule applies when the message has any of them; leave empty to apply regardless of tags.

tag_ids
data
object

Additional rule data

Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json