crm-notifications

Preview a CRM notification audience

Changed on

Counts the patients an audience holds now (commercial-communications opt-outs excluded) and how many of them have an active device to reach.

post/api/notification-campaigns/preview

Request

  • Base URL: https://api.corabea.it (the document declares no server; this is the origin it was published from)
  • URL: https://api.corabea.it/api/notification-campaigns/preview
  • Auth: HTTP bearer

Request body

patient_statesstring[]

Stato paziente filters, the same values as the CRM emails.

registration_reasonsstring[]

Motivo iscrizione filters (users.registration_reason).

filter_match'any' | 'all'

How stato and motivo filters combine: 'any' (OR, default) or 'all' (AND).

recipient_emailsstring[]

Explicit recipient email addresses (e.g. an uploaded CSV); addresses with no account are skipped.

user_idsstring[]

Explicit patient user ids (e.g. the filtered CRM patient list).

Response

Successful Response

recipient_countinteger required

Patients in the audience, commercial-communications opt-outs excluded (CSV: only the addresses that belong to an account).

reachable_countinteger required

Of those, the patients with at least one active device for push.

Changes