Outbound

Preview an Outbound audience

Estimate the audience for the same public audience object used by create and PATCH. Fields, operators, and value types are validated from workspace metadata. Explicit everyone:true selects all people of the selected types. Returns a bounded count and sample rows, not a guaranteed send count: schedules, browser triggers, subscriptions and delivery limits still apply. Recipient identity data requires manage_outbound and view_users; MCP Writer cannot call this endpoint.

POST

/v2/outbound/audience/preview

curl --request POST \
  --url https://do.featurebase.app/v2/outbound/audience/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-09-03.pulsar' \
  --header 'Content-Type: application/json' \
  --data '
{
  "audience": {
    "all": [
      {
        "field": "customFields.plan",
        "operator": "is",
        "value": "<string>"
      }
    ],
    "mode": "dynamic",
    "types": [
      "users"
    ]
  }
}
'

{
  "data": [
    {
      "companyName": "Acme Inc.",
      "email": "jane@example.com",
      "id": "6457e3ff70afca5d8c27dccc",
      "lastSeen": "2026-09-02T08:00:00.000Z",
      "name": "Jane Doe",
      "profilePicture": null,
      "type": "User"
    }
  ],
  "object": "outbound_audience_preview",
  "totalCount": 1250,
  "totalCountCap": 10000,
  "totalCountIsCapped": false
}

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-09-03.pulsar, 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover

Example: 2026-09-03.pulsar

Body

audienceobjectrequired

Explicit delivery audience. Defaults: types=[users], mode=dynamic. Use everyone:true only when all people of the selected types are intended. Email supports users only. Banners and surveys support dynamic mode only.

Show child attributes

Response

Success

dataobject[]required

Sample of matching people

Show child attributes

objectenum<string>required

Object type identifier

Available options: outbound_audience_preview

Example: outbound_audience_preview

totalCountnumber | nullrequired

Matching people, or null when the count could not be computed in time

Example: 1250

totalCountCapnumberrequired

Upper bound applied to the count

Example: 10000

totalCountIsCappedbooleanrequired

Whether totalCount stopped at totalCountCap

Example: false

Still need help? Ask the team