crm-notifications

List CRM notifications

Changed on

Scheduled and sent CRM notifications, including the immediate sends from the patient list, latest send date first.

get/api/notification-campaigns

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
  • Auth: HTTP bearer

Query parameters

limitinteger

Max notifications to return.

offsetinteger

Pagination offset.

Response

Successful Response

idstring required

Campaign UUID.

statusstring required

scheduled | sending | sent | failed | cancelled.

scheduled_atstring date-time nullable

When it is, or was, scheduled to go out.

titlestring required

Notification title.

bodystring required

Notification text.

notesstring nullable

Internal note; CRM-only.

audience_typestring required

'filters', 'csv' or 'users'.

audience_sizeinteger nullable

Addresses (csv) or patients (users) in an explicit audience; null for filters.

resolved_countinteger nullable

Patients in the audience when it was sent.

reached_countinteger nullable

Patients reached on at least one device.

unreached_countinteger nullable

Patients not reached.

sent_atstring date-time nullable

When the send finished.

errorstring nullable

Failure reason, if the send failed.

created_by_namestring nullable

Who created it, when known.

created_atstring date-time required

When it was created.

Changes