v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Loyalty

Post Loyalty Program Customers Push

Send Push Message to All Customers

Sends a push notification to all customers associated with a specific loyalty program.

Path Parameters:

  • programId: UUID of the loyalty program

Request Body:

  • message: The message content to send (optional)

Note:

  • Excessive usage of push notifications can lead to rate limiting or blocking of your cards.

Returns:

  • recipients: How many customers the message is being sent to. Marketing consent is opt-in, so this counts only customers who answered yes.
  • members: How many customers hold the pass. Lower recipients than members means the difference has not granted marketing consent.
  • HTTP 409 if the program requires consent but defines no field to collect it, or if the message is one the audience already holds — wallet passes only raise a notification when the text changes, so re-sending it would notify nobody.
post/v2/loyalty/programs/{programId}/customers/push

Path parameters

string required
OR
string required
Example:5eb7cf5a86d9755df3a6c593

Headers

authorizationstring nullable

Request body

messagestring nullable

Response

Successful Response

{"stackTrail":"paths:/v2/loyalty/programs/{programId}/customers/push:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}