Thanx · JSON Structure

Consumer Api User Envelope Structure

UserEnvelope schema from Thanx Consumer API

Type: object Properties: 1
RestaurantLoyaltyGuest EngagementMarketingCRMOnline OrderingWebhooksPointsRewardsCampaigns

UserEnvelope is a JSON Structure definition published by Thanx, describing 1 property. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

user

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/thanx/refs/heads/main/json-structure/consumer-api-user-envelope-structure.json",
  "name": "UserEnvelope",
  "description": "UserEnvelope schema from Thanx Consumer API",
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "92b7b0dac4"
        },
        "email": {
          "type": "string",
          "example": "jane.smith@example.com"
        },
        "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": "int32",
              "example": 1987
            },
            "month": {
              "type": "int32",
              "example": 8
            },
            "day": {
              "type": "int32",
              "example": 14
            }
          }
        },
        "zip_code": {
          "type": "string",
          "example": "94105"
        }
      }
    }
  }
}