Notifications API
Send push notifications to users with active wallet cards. Notifications appear on users' lock screens, linked to their wallet card.
Send Campaign Notification
/campaigns/{campaignId}/notificationscampaigns:writeSend a push notification to all recipients with active wallet cards in a campaign.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
header | string | Yes | Notification header/title (max 100 chars) |
body | string | Yes | Notification message body (max 500 chars) |
Campaigns are limited to 3 notifications lifetime to prevent spam. Attempting to exceed this limit returns a 429 error with code NOTIFICATION_LIMIT_EXCEEDED.
Notifications are only sent to recipients whose wallet cards are in active status. Cards that are draft, revoked, expired, or removed are automatically skipped.
Schedule Campaign Notification
/campaigns/{campaignId}/notifications/schedulecampaigns:writeSchedule a push notification to be sent at a specific time in the future.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
header | string | Yes | Notification header/title (max 100 chars) |
body | string | Yes | Notification message body (max 500 chars) |
scheduledFor | string | Yes | ISO 8601 datetime when notification should be sent (must be in future, max 30 days) |
Scheduling Constraints:
scheduledFormust be in the futurescheduledFormust be within 30 days from now- Maximum 3 notifications per campaign (lifetime, including immediate notifications)
List Scheduled Notifications
/campaigns/{campaignId}/notifications/scheduledcampaigns:readList all scheduled notifications for a campaign, with optional filtering by status.
Get Scheduled Notification
/campaigns/{campaignId}/notifications/{notificationId}campaigns:readGet details of a specific scheduled notification.
Cancel Scheduled Notification
/campaigns/{campaignId}/notifications/{notificationId}campaigns:writeCancel a scheduled notification. Only notifications with pending status can be cancelled.