30 days free. No credit card. Full access from the moment you connect your site.

Start free trial

MailerPress Pro Contacts In A Segment

mailerpress-pro/get-segments-for-contact lists the contacts that currently satisfy a named segment’s conditions.

Currently is the operative word: the conditions are evaluated when you ask.

At a glance

Abilitymailerpress-pro/get-segments-for-contact
ToolsetMailerPress Pro — toolset/mailerpress-pro
GroupMailerPress Pro › Segments
RequiresAcrossAI Pro, plus MailerPress with its Pro add-on active on the site
Capabilitymanage_options
SafetyRead-only — changes nothing
RepeatableIdempotent — running it twice leaves the same result
Ships inAcrossAI Pro 0.9.16 and later

How it works

This is what makes a segment useful and what makes it surprising. Sending to a segment sends to whoever matches at send time, which may be more or fewer people than when the campaign was set up.

So checking the membership immediately before a send is a different question from checking it when the segment was written, and the answer can differ by a lot on conditions involving dates or activity.

It addresses the segment by name rather than by ID, which is convenient and means a renamed segment breaks anything referring to it by the old name.

A segment returning nobody is worth distinguishing from a segment that is wrong. Empty is a legitimate answer for a condition nobody currently meets; mailerpress-pro/list-segment-condition-metadata is how you check the conditions are expressible rather than merely unmatched.

Input

NameTypeRequiredWhat it is
segment_namestringYesThe segment name.

What comes back

NameTypeWhat it is
contactsarrayThe contacts currently satisfying the segment.
countintegerHow many.
successbooleanWhether the call completed.
messagestringA one-line summary of what happened, suitable for showing a human.
error_codestringPresent only on failure — a stable machine-readable reason, such as a missing field, a wrong field type or an unmet confirmation.

Example

Ask your assistant:

Who is currently in the lapsed-customers segment?

It resolves to one call:

{
  "ability": "mailerpress-pro/get-segments-for-contact",
  "parameters": {
    "segment_name": "Lapsed customers"
  }
}

Worth knowing

  • Evaluated at call time. A send uses the membership at send time.
  • Addressed by name — renaming a segment breaks references to it.
  • Empty can be correct. Check the conditions separately.
  • Read-only.

Related abilities


Get the plugins:
AcrossAI Abilities Manager · AcrossAI MCP Manager

Browse the rest: Every ability, by category


Keep reading