1. Home
  2. /Developer
  3. /REST APIs
  4. /Wallet API
  5. /Operations
  6. /Push Notifications

Push Notifications

Send a push notification to end users who have iOS or Android passes installed, letting them know information has changed. By notifying users, they will receive an alert as well as an update to the back of the pass showing the most recent notification.

Delete notification by pass

Removes notification field and message from the back of the pass.

Jump to examples ↓

DELETE /pass/{passId}/notify

Security:

Path parameters:

  • passId stringREQUIRED
    The id of the pass you want send notification to.

Responses

  • 200

    Notification is being deleted. The response contains a ticketId that you can use to look up the operation.

    Response body:

    • Content-Type: application/json
      OBJECT PROPERTIES
      • ticketId integer

        An identifier for this operation.

  • 404

    The pass does not exist.

Examples

Example request

DELETE /v1/pass/123/notify HTTP/1.1
Authorization: Basic <Base64 key>

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
   "ticketId": 12345
}

Delete notification by pass with external ID

Removes notification field and message from the back of the pass.

Jump to examples ↓

DELETE /pass/template/{templateId}/id/{passExternalId}/notify

Security:

Path parameters:

  • templateId stringREQUIRED
    The template ID for the pass you want to send or delete notification for.
  • passExternalId stringREQUIRED
    The custom identifier of the pass you want to send or delete notification for.

Responses

  • 200

    Notification is being deleted. The response contains a ticketId that you can use to look up the operation.

    Response body:

    • Content-Type: application/json
      OBJECT PROPERTIES
      • ticketId integer

        An identifier for this operation.

  • 404

    The pass does not exist.

Examples

Example request

DELETE /v1/pass/template/12345/id/my_custom_pass_id/notify HTTP/1.1
Authorization: Basic <Base64 key>

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
   "ticketId": 12345
}

Delete notification by segment

Delete pass notification for specified segment.

Jump to examples ↓

DELETE /segments/{projectId}/{segmentId}/notify

Security:

Query parameters:

  • templateId string

Path parameters:

  • projectId stringREQUIRED
    The ID of the project you want to delete the notification for.
  • segmentId stringREQUIRED
    The ID of the segment you want to delete the notification for.

Responses

  • 200

    Notification is being deleted. The response contains a ticketId that you can use to look up the operation.

    Response body:

    • Content-Type: application/json
      OBJECT PROPERTIES
      • ticketId integer

        An identifier for this operation.

  • 404

    The segment does not exist.

Examples

Example request

DELETE /v1/segments/12345/3b13666df-e5b3-4e42-8919-f8d63bd7ce2a/notify?templateId=6789 HTTP/1.1
Authorization: Basic <Base64 key>

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
   "ticketId": 12345
}

Delete notification by tag

Delete notification for passes associated with the specified tag.

Jump to examples ↓

DELETE /tag/{tag}/notify

Security:

Query parameters:

  • templateId stringREQUIRED
    The template ID associated with the passes you want to send or delete notification for.

Path parameters:

  • tag stringREQUIRED
    The tag associated with the passes you want to send or delete notification for.

Responses

  • 200

    Notification is being deleted. The response contains a ticketId that you can use to look up the operation.

    Response body:

    • Content-Type: application/json
      OBJECT PROPERTIES
      • ticketId integer

        An identifier for this operation.

  • 404

    The tag does not exist.

Examples

Example request

DELETE /v1/tag/campaign123/notify?templateId=12345 HTTP/1.1
Authorization: Basic <Base64 key>

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
   "ticketId": 12345
}

Delete notification by template

Delete pass notification for specified template passes.

Jump to examples ↓

DELETE /template/{templateId}/notify

Security:

Path parameters:

  • templateId stringREQUIRED
    The id of the template you want to send or delete notification for. For External IDs, format the {templateId} as id/{templateExternalId}.

Responses

  • 200

    Notification is being deleted. The response contains a ticketId that you can use to look up the operation.

    Response body:

    • Content-Type: application/json
      OBJECT PROPERTIES
      • ticketId integer

        An identifier for this operation.

  • 404

    The template does not exist.

Examples

Example request

DELETE /v1/template/123/notify HTTP/1.1
Authorization: Basic <Base64 key>

Example request with external ID

DELETE /v1/template/id/12345/notify HTTP/1.1
Authorization: Basic <Base64 key>

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
   "ticketId": 12345
}

Send notification by pass

Send a notification to a pass. Delivers lock screen notification through the wallet app and presents notification field and message on the back of the pass.

Jump to examples ↓

POST /pass/{passId}/notify

Security:

Path parameters:

  • passId stringREQUIRED
    The id of the pass you want send notification to.

Request body:

Send notification to a pass.

  • Content-Type: application/json

    Pass Notification Request

    An object for sending a custom pass notification message.

    OBJECT PROPERTIES
    • label string

      Optional header for the message.

    • value stringREQUIRED

      The body of the notification message.

Responses

  • 200

    Notification is being sent. The response contains a ticketId that you can use to look up the operation.

    Response body:

    • Content-Type: application/json
      OBJECT PROPERTIES
      • ticketId integer

        An identifier for this operation.

  • 404

    The pass does not exist.

Examples

Example request

POST /v1/pass/123/notify HTTP/1.1
Content-Type: application/json
Authorization: Basic <Base64 key>

{
  "label": "Last Notification",
  "value": "20% off any one regular priced item"
}

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
   "ticketId": 1234
}

Send notification by pass with external ID

Send a notification to a pass. Delivers lock screen notification through the wallet app and presents notification field and message on the back of the pass.

Jump to examples ↓

POST /pass/template/{templateId}/id/{passExternalId}/notify

Security:

Path parameters:

  • templateId stringREQUIRED
    The template ID for the pass you want to send or delete notification for.
  • passExternalId stringREQUIRED
    The custom identifier of the pass you want to send or delete notification for.

Request body:

Send notification to a pass.

  • Content-Type: application/json

    Pass Notification Request

    An object for sending a custom pass notification message.

    OBJECT PROPERTIES
    • label string

      Optional header for the message.

    • value stringREQUIRED

      The body of the notification message.

Responses

  • 200

    Notification is being sent. The response contains a ticketId that you can use to look up the operation.

    Response body:

    • Content-Type: application/json
      OBJECT PROPERTIES
      • ticketId integer

        An identifier for this operation.

  • 404

    The pass does not exist.

Examples

Example request

POST /v1/pass/template/12345/id/my_custom_pass_id/notify HTTP/1.1
Content-Type: application/json
Authorization: Basic <Base64 key>

{
  "label": "Last Notification",
  "value": "20% off any one regular priced item"
}

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
   "ticketId": 1234
}

Send notification by segment

Send a notification to all passes for a segment.

Jump to examples ↓

POST /segments/{projectId}/{segmentId}/notify

Security:

Query parameters:

  • templateId stringREQUIRED

Path parameters:

  • projectId stringREQUIRED
    The ID of the project you want to send the notification to.
  • segmentId stringREQUIRED
    The ID of the segment you want to send the notification to.

Request body:

Send notification to segment passes.

  • Content-Type: application/json

    Pass Notification Request

    An object for sending a custom pass notification message.

    OBJECT PROPERTIES
    • label string

      Optional header for the message.

    • value stringREQUIRED

      The body of the notification message.

Responses

  • 200

    Notification is being sent. The response contains a ticketId that you can use to look up the operation.

    Response body:

    • Content-Type: application/json
      OBJECT PROPERTIES
      • ticketId integer

        An identifier for this operation.

  • 404

    The segment does not exist.

Examples

Example request

POST /v1/segments/12345/3b13666df-e5b3-4e42-8919-f8d63bd7ce2a/notify?templateId=6789 HTTP/1.1
Content-Type: application/json
Authorization: Basic <Base64 key>

{
  "label": "Last Notification",
  "value": "20% off any one regular priced item"
}

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
   "ticketId": 1234
}

Send notification by tag

Send notification to all passes associated with the specified tag.

Jump to examples ↓

POST /tag/{tag}/notify

Security:

Query parameters:

  • templateId stringREQUIRED
    The template ID associated with the passes you want to send or delete notification for.

Path parameters:

  • tag stringREQUIRED
    The tag associated with the passes you want to send or delete notification for.

Request body:

Send notification to tagged passes.

  • Content-Type: application/json

    Pass Notification Request

    An object for sending a custom pass notification message.

    OBJECT PROPERTIES
    • label string

      Optional header for the message.

    • value stringREQUIRED

      The body of the notification message.

Responses

  • 200

    Notification is being sent. The response contains a ticketId that you can use to look up the operation.

    Response body:

    • Content-Type: application/json
      OBJECT PROPERTIES
      • ticketId integer

        An identifier for this operation.

  • 404

    The tag does not exist.

Examples

Example request

POST /v1/tag/campaign123/notify?templateId=12345 HTTP/1.1
Content-Type: application/json
Authorization: Basic <Base64 key>

{
  "label": "Last Notification",
  "value": "20% off any one regular priced item"
}

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
   "ticketId": 1234
}

Send notification by template

Send a notification to all passes belonging to the template.

Jump to examples ↓

POST /template/{templateId}/notify

Security:

Path parameters:

  • templateId stringREQUIRED
    The id of the template you want to send or delete notification for. For External IDs, format the {templateId} as id/{templateExternalId}.

Request body:

Send notification to template passes.

  • Content-Type: application/json

    Pass Notification Request

    An object for sending a custom pass notification message.

    OBJECT PROPERTIES
    • label string

      Optional header for the message.

    • value stringREQUIRED

      The body of the notification message.

Responses

  • 200

    Notification is being sent. The response contains a ticketId that you can use to look up the operation.

    Response body:

    • Content-Type: application/json
      OBJECT PROPERTIES
      • ticketId integer

        An identifier for this operation.

  • 404

    The pass does not exist.

Examples

Example request

POST /v1/template/123/notify HTTP/1.1
Content-Type: application/json
Authorization: Basic <Base64 key>

{
  "label": "Last Notification",
  "value": "20% off any one regular priced item"
}

Example request with external ID

POST /v1/template/id/12345/notify HTTP/1.1
Content-Type: application/json
Authorization: Basic <Base64 key>

{
  "label": "Last Notification",
  "value": "20% off any one regular priced item"
}

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
   "ticketId": 1234
}