Send to a pass

curl https://api.tapace.lk/v1/passes/pass_7hGk2LmQ9xVt4RnB8cYe/notifications \
  -H "Authorization: Bearer $TAPACE_API_KEY" \
  -H "Idempotency-Key: 4d8b1e3a-7c2f-4a9e-b5d1-2e6c9a3f7b10" \
  -H "Content-Type: application/json" \
  -d '{
    "appleText": "Your table is ready.",
    "googleTitle": "Table ready",
    "googleBody": "Your table is ready. Please come to the front desk."
  }'

{
  "object": "notification",
  "id": "ntf_Qm3Vx8Lt2Nr7Kp4Zs9Wc",
  "scope": "pass",
  "environment": "test",
  "templateId": "tmpl_Q4vN8xT2mLr7KpZs3Wd1",
  "passId": "pass_7hGk2LmQ9xVt4RnB8cYe",
  "deploymentId": null,
  "deploymentRevision": null,
  "appleText": "Your table is ready.",
  "googleTitle": "Table ready",
  "googleBody": "Your table is ready. Please come to the front desk.",
  "status": "queued",
  "statusReason": null,
  "scheduledFor": null,
  "audience": 0,
  "actor": { "id": "cmgx4k2p90001ab12cd34ef56", "name": null, "email": null },
  "totals": null,
  "delivery": null,
  "createdAt": "2026-10-18T09:00:00.000Z",
  "updatedAt": "2026-10-18T09:00:00.000Z",
  "startedAt": null,
  "sentAt": null
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "Enter the Apple Wallet message."
  },
  "requestId": "req_8f3a2c1d9e7b6a54"
}

POST

passes

{id}

notifications

curl https://api.tapace.lk/v1/passes/pass_7hGk2LmQ9xVt4RnB8cYe/notifications \
  -H "Authorization: Bearer $TAPACE_API_KEY" \
  -H "Idempotency-Key: 4d8b1e3a-7c2f-4a9e-b5d1-2e6c9a3f7b10" \
  -H "Content-Type: application/json" \
  -d '{
    "appleText": "Your table is ready.",
    "googleTitle": "Table ready",
    "googleBody": "Your table is ready. Please come to the front desk."
  }'

{
  "object": "notification",
  "id": "ntf_Qm3Vx8Lt2Nr7Kp4Zs9Wc",
  "scope": "pass",
  "environment": "test",
  "templateId": "tmpl_Q4vN8xT2mLr7KpZs3Wd1",
  "passId": "pass_7hGk2LmQ9xVt4RnB8cYe",
  "deploymentId": null,
  "deploymentRevision": null,
  "appleText": "Your table is ready.",
  "googleTitle": "Table ready",
  "googleBody": "Your table is ready. Please come to the front desk.",
  "status": "queued",
  "statusReason": null,
  "scheduledFor": null,
  "audience": 0,
  "actor": { "id": "cmgx4k2p90001ab12cd34ef56", "name": null, "email": null },
  "totals": null,
  "delivery": null,
  "createdAt": "2026-10-18T09:00:00.000Z",
  "updatedAt": "2026-10-18T09:00:00.000Z",
  "startedAt": null,
  "sentAt": null
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "Enter the Apple Wallet message."
  },
  "requestId": "req_8f3a2c1d9e7b6a54"
}

Use this for a message meant for one holder, such as “Your table is ready”. To message every holder of a template, send to a template. To change a value on the pass and alert the holder about it, update the pass with notificationMode: "notify" instead. How it reaches each wallet:

Apple Wallet: the text replaces the pass’s Message for you field on the back, and Wallet shows it on the lock screen. Apple only alerts when the text changes, so a text identical to the current one is rejected.
Google Wallet: the title and body appear as a message on the pass. Google allows 3 notifications per pass in 24 hours. Beyond that, the message is added without an alert.

string

required

The pass ID.

string

required

A unique value, such as a UUID, so a retry never sends twice. See Idempotency.

string

The Apple Wallet message, up to 120 characters. Required when the pass is issued for Apple Wallet.

string

The Google Wallet message title, up to 60 characters. Required when the pass is issued for Google Wallet.

string

The Google Wallet message body, up to 500 characters. Required when the pass is issued for Google Wallet.

string

When to send it, as an ISO 8601 time from 5 minutes to 24 hours from now. Leave it out to send now.

Texts for a wallet the pass isn’t issued for are ignored.

Response

Returns the new notification with status 201. Its status is queued when it’s sent now, or scheduled.

Errors

Status	When
`400`	A required text is missing or too long, `scheduledFor` is outside the allowed window, the Apple text is identical to the current one, or the pass is voided.
`404`	The pass doesn’t exist.

curl https://api.tapace.lk/v1/passes/pass_7hGk2LmQ9xVt4RnB8cYe/notifications \
  -H "Authorization: Bearer $TAPACE_API_KEY" \
  -H "Idempotency-Key: 4d8b1e3a-7c2f-4a9e-b5d1-2e6c9a3f7b10" \
  -H "Content-Type: application/json" \
  -d '{
    "appleText": "Your table is ready.",
    "googleTitle": "Table ready",
    "googleBody": "Your table is ready. Please come to the front desk."
  }'

{
  "object": "notification",
  "id": "ntf_Qm3Vx8Lt2Nr7Kp4Zs9Wc",
  "scope": "pass",
  "environment": "test",
  "templateId": "tmpl_Q4vN8xT2mLr7KpZs3Wd1",
  "passId": "pass_7hGk2LmQ9xVt4RnB8cYe",
  "deploymentId": null,
  "deploymentRevision": null,
  "appleText": "Your table is ready.",
  "googleTitle": "Table ready",
  "googleBody": "Your table is ready. Please come to the front desk.",
  "status": "queued",
  "statusReason": null,
  "scheduledFor": null,
  "audience": 0,
  "actor": { "id": "cmgx4k2p90001ab12cd34ef56", "name": null, "email": null },
  "totals": null,
  "delivery": null,
  "createdAt": "2026-10-18T09:00:00.000Z",
  "updatedAt": "2026-10-18T09:00:00.000Z",
  "startedAt": null,
  "sentAt": null
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "Enter the Apple Wallet message."
  },
  "requestId": "req_8f3a2c1d9e7b6a54"
}

Getting started

Basics

Guides

Node.js SDK

API keys

Passes

Loyalty cards

Notifications

Templates

Wallet signing

Deployments

Assets

Send to a pass

Response

Errors

​Response

​Errors

Response

Errors