Notificar al cliente en su wallet
Wallet passes
POST /v1/loyalty/memberships/{id}/passes/notify
Push a message to the customer’s wallet card on their phone, with an optional link button.
POST
Notificar al cliente en su wallet
Pushes a message to the wallet card on the customer’s phone — a lock-screen notification and a line on the back of the card. No app required, and no messaging channel involved.
Use it for something the customer will care about: they are two stamps from a free coffee, their points expire this month, a tier unlocked.
Endpoint
Required scope
loyalty:write
Headers
Path parameters
Body
Example request
Response
200 OK
400 Bad Request
Missingheader or body, a field over its length limit, or a link_url that is not an absolute https URL.
401 Unauthorized
Missing, invalid, revoked, or expired token.403 Forbidden
The token does not have theloyalty:write scope.
404 Not Found
No membership with that id in your company.502 Bad Gateway
The loyalty service is unreachable.Operational notes
notified: 0is a success, not an error. It means the customer has no pass registered on any device — they never added the card, or they removed it. The call still returns200and the message is recorded in the history.- The counts are devices, not people. A customer with the card on a phone and a watch counts as two.
- You do not need this to update a balance. Ledger movements refresh the card’s numbers on their own. Notify is for saying something, not for syncing.
- Both platforms are attempted. The
channelsrecorded in the history show which ones actually went out. - There is no scheduling and no audience. One call, one membership, sent now. Batching a campaign means iterating memberships yourself — and the rate limits apply to each call.
- Delivery is best effort. Apple and Google decide whether and when to surface the notification; a
notifiedcount means it was handed off, not that it was seen.
Authorizations
Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.
Path Parameters
Body
application/json
Título del mensaje que ve el cliente en la wallet
Example:
"Te quedan 3 sellos"
Cuerpo del mensaje
Example:
"Junta 3 sellos más y tu próximo café va por la casa."
URL https a la que lleva el botón del mensaje
Example:
"https://tutienda.cl/promos"
Example:
"Ver promos"