Send push notifications

curl --request POST "$PERKSTAR_API_URL/pushes" \
  --header "Authorization: Bearer $PERKSTAR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: summer-reminder-enrolment_123" \
  --data '{
    "enrollment_id": "enrolment_123",
    "message": "Hi {firstName}, your {cardName} is ready for your next visit."
  }'

​

Merge fields

• {firstName}
• {balance}
• {installLink}
• {shareLink}
• {cardName}
• {orgName}

​

Delivery behaviour

• A three-minute cooldown applies per card across dashboard and API sends.
• 429 includes Retry-After when the cooldown or key limit is hit.
• The response reports attempted and failed platforms.
• Test credentials return test_mode: true without delivering or writing a broadcast row.
• A successful API response means Perkstar handed the update to the wallet platform; device display is controlled by Apple or Google.

​

Safe automation

• Send only when the workflow has a clear customer purpose.
• Respect consent and suppression state returned by Perkstar.
• Use one idempotency key per intended message.
• Do not include health data, payment details, passwords, or other sensitive information.
• Rate-limit upstream triggers so a bulk sync cannot notify the same customer repeatedly.