Punchh · Schema

CreateUserRequest

CreateUserRequest schema from PAR Punchh Mobile API

RestaurantLoyaltyMarketingGuest EngagementOnline OrderingMobilePoint Of SaleWebhooks

Properties

Name Type Description
client string OAuth client ID provided by the business.
email string
password string
first_name string
View JSON Schema on GitHub

JSON Schema

mobile-create-user-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CreateUserRequest",
  "description": "CreateUserRequest schema from PAR Punchh Mobile API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-create-user-request-schema.json",
  "type": "object",
  "properties": {
    "client": {
      "type": "string",
      "description": "OAuth client ID provided by the business.",
      "example": "business_client_key"
    },
    "email": {
      "type": "string",
      "format": "email",
      "example": "[email protected]"
    },
    "password": {
      "type": "string",
      "example": "example"
    },
    "first_name": {
      "type": "string",
      "example": "Jane Smith"
    }
  },
  "required": [
    "client",
    "email",
    "password"
  ]
}