Campaigns

Who would receive, without creating a campaign

Permission required: subscribers:read. Read-only: nothing is created, nothing is sent.

Returns what a campaign sent right now to the whole list would reach — restricted to to if given, with the same per-address breakdown as the send. To display "12 will receive, 3 are excluded" while someone chooses who to write to, without creating a draft.

Campaign-specific checks (subject, content, quota, segment) remain those of dry_run on POST /api/v1/campaigns/{id}/send.

post/api/v1/audience

Request

  • Base URL: https://mailcheer.com
  • URL: https://mailcheer.com/api/v1/audience
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Request body

tostring[]

Optional. Restricts the send to these addresses — only those that are active subscribers of the audience, never an address on the suppression list. Omitted: the whole audience. Empty ([]): nobody, the send is refused.

Response

The recipient count, and the per-address breakdown if to is given.

object'audience'
recipientsinteger

Changes

No recorded changes to this operation across all 1 revision of this API.