How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Punchh Notifications API

The Notifications API from Punchh — 5 operation(s) for notifications.

Punchh Notifications API is one of 46 APIs that Punchh publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 26 JSON Schema definitions.

Tagged areas include Notification. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, a JSON-LD context, and 26 JSON Schemas.

This API exposes 5 operations across 5 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://SERVER_NAME_GOES_HERE.punchh.com.

5 operations 5 paths 4 schemas 2 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{server_name}.punchh.com
Resource Areas
1

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 2 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Notifications 5
GET
/api2/mobile/notifications
Fetch User Notifications
mobile_fetch_user_notifications 6 params body → 200400401403412
DELETE
/api2/mobile/notifications/id
Delete User Notification
mobile_delete_user_notification 7 params body → 200
GET
/api2/mobile/messages
Fetch Messages
mobile_messages 6 params body → 200
POST
/api2/mobile/message_readerships
Mark Messages As Read
mobile_mark_messages_read 5 params body → 202400401
DELETE
/api2/mobile/message_readerships/{message_id}
Delete Messages
mobile_delete_messages 6 params body → 200400401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are hero-content (4 properties), background-content (4 properties), messages (1 property). Each schema is shown below with its type and property counts.

cta
array
Short for call to action, a device designed to prompt an immediate response from a user json [ { "type": "externalweblink", "link": "URLGOESHERE", "label": "Mo…
background-content
object
This is the content that makes the background of the message. json { "type": "image", "url": "IMAGEURLGOESHERE", "alttext": "Black Background Image", "initialf…
4 properties
hero-content
object
This is the first visual content that a user encounters when the user views a rich message. This can be an image or a video. json { "type": "image", "url": "IM…
4 properties
messages
object
Returned in response to the [Fetch Messages](/docs/dev-portal-mobile/e9485ca96ff55-fetch-messages) API
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

punchh-notifications-api-openapi.yml Raw ↑

Other APIs Punchh publishes across the network.

Punchh POS API
Punchh Api2 API
Punchh Auth API
Punchh Badges API
Punchh Beacons API
Punchh Business Admin Users API
Punchh Business Migration Users API
Punchh Challenges API
Punchh Check In API
Punchh Check Ins API
Punchh Check User Balance API
Punchh Collectibles API
Where this information came from

This is an independent, third-party profile of Punchh Notifications API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.