Communications

Messages shown on the back of passes and notified to holders.

📄️Create a communication

Creates a communication (offer) shown on the loyalty card of every holder in the wallet: a `strip` image replaces the card's banner and the `description` is added to the back. It goes live right away with `instant: true`, otherwise at `startDate`, and runs until `endDate`, or with no end with `unlimited: true`. Returns the created communication.

📄️List communications

Paginated list of the wallet's communications, filterable by status, by start-date range and by a text search on the description.

📄️Update a communication

Updates a communication: text, image, dates or status (`EXPIRED` is not accepted). If the communication is live, the card is updated and holders are notified. Returns the updated communication.

📄️Delete a communication

Permanently deletes a communication. If it was live (`ACTIVE`), the loyalty card gets its original image back and holders are notified that the offer has ended. Returns the deleted communication.

📄️Get a communication

Returns a communication by ID, with its status, dates and the key of its `strip` image.

📄️Activate or deactivate a communication

Activates (`ACTIF`) or deactivates (`INACTIF`) a communication without changing its content. Activating puts it live on the loyalty card; deactivating a live communication restores the card's original image.

📄️Get communication delivery statistics

Delivery statistics for a communication's push notification, per holder of an active loyalty card (with their email and phone number), paginated, with an overall and per-platform (iOS, Android) success summary. The summary also gives the communication's status and its next milestone (start or end).