Punchh · JSON Structure

Mobile Create User Request Structure

CreateUserRequest schema from PAR Punchh Mobile API

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

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

Properties

client email password first_name

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-create-user-request-structure.json",
  "name": "CreateUserRequest",
  "description": "CreateUserRequest schema from PAR Punchh Mobile API",
  "type": "object",
  "properties": {
    "client": {
      "type": "string",
      "description": "OAuth client ID provided by the business.",
      "example": "business_client_key"
    },
    "email": {
      "type": "string",
      "example": "jsmith@example.com"
    },
    "password": {
      "type": "string",
      "example": "example"
    },
    "first_name": {
      "type": "string",
      "example": "Jane Smith"
    }
  },
  "required": [
    "client",
    "email",
    "password"
  ]
}