API Docs / Operations / Email - Broadcasts / Summarise Broadcast Audience

Summarise Broadcast Audience

POST /tenants/{tenant}/email-broadcasts/audience-summary

Evaluates a client selection (saved view or inline filter, plus additions and exclusions) and returns how many clients it resolves to and how many of those have not opted in to email contact. When a To-recipient configuration is included, also counts clients with no resolvable email address. Read-only — used by the wizard before a draft exists.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

{
  "savedViewCode": "string",
  "filter": {
    "managerCodes": [
      "..."
    ],
    "partnerCodes": [
      "..."
    ],
    "associateCodes": [
      "..."
    ],
    "statuses": [
      "..."
    ],
    "types": [
      "..."
    ]
  },
  "excludedClientCodes": [
    "string"
  ],
  "additionalClientCodes": [
    "string"
  ],
  "allContacts": false
}

Responses

400 Bad Request
401 Unauthorized – Invalid or missing API key