Punchh · JSON Structure

Mobile Mark Offers Read Request Structure

MarkOffersReadRequest schema from PAR Punchh Mobile API

Type: object Properties: 4 Required: 1
RestaurantLoyaltyMarketingGuest EngagementOnline OrderingMobilePoint Of SaleWebhooks

MarkOffersReadRequest is a JSON Structure definition published by Punchh, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

client event_type rewards user_notifications

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-mark-offers-read-request-structure.json",
  "name": "MarkOffersReadRequest",
  "description": "MarkOffersReadRequest schema from PAR Punchh Mobile API",
  "type": "object",
  "properties": {
    "client": {
      "type": "string",
      "description": "OAuth client ID provided by the business.",
      "example": "business_client_key"
    },
    "event_type": {
      "type": "string",
      "enum": [
        "read_through_app",
        "app_open_via_push"
      ],
      "example": "read_through_app"
    },
    "rewards": {
      "type": "string",
      "description": "Comma-separated IDs of rewards.",
      "example": "example"
    },
    "user_notifications": {
      "type": "string",
      "description": "Comma-separated IDs of user notifications.",
      "example": "example"
    }
  },
  "required": [
    "client"
  ]
}