Thanx · Schema

UserEnvelope

UserEnvelope schema from Thanx Consumer API

RestaurantLoyaltyGuest EngagementMarketingCRMOnline OrderingWebhooksPointsRewardsCampaigns

Properties

Name Type Description
user object
View JSON Schema on GitHub

JSON Schema

consumer-api-user-envelope-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "UserEnvelope",
  "description": "UserEnvelope schema from Thanx Consumer API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-schema/consumer-api-user-envelope-schema.json",
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "92b7b0dac4"
        },
        "email": {
          "type": "string",
          "format": "email",
          "example": "[email protected]"
        },
        "phone": {
          "type": "string",
          "description": "E.164 formatted phone number.",
          "example": "+14158672345"
        },
        "first_name": {
          "type": "string",
          "example": "Jane"
        },
        "last_name": {
          "type": "string",
          "example": "Smith"
        },
        "birth_date": {
          "type": "object",
          "properties": {
            "year": {
              "type": "integer",
              "example": 1987
            },
            "month": {
              "type": "integer",
              "example": 8
            },
            "day": {
              "type": "integer",
              "example": 14
            }
          }
        },
        "zip_code": {
          "type": "string",
          "example": "94105"
        }
      }
    }
  }
}