Mews · Schema

Loyalty membership update parameters

HospitalityHotelsPMSProperty Management

Properties

Name	Type	Description
LoyaltyMembershipId	string	Unique identifier of the loyalty membership.
LoyaltyProgramId	object	Unique identifier of the loyalty program (or `null` if the program should not be updated).
State	object	State of the loyalty membership, (or `null` if the state should not be updated).
IsPrimary	object	Boolean value defining the primary loyalty membership for the account (or `null` if the value should not be updated).
Code	object	Code of the loyalty membership. (or `null` if the code should not be updated).
MembershipNumber	object	Customer-facing membership numbers, e.g., printed on a loyalty card.
ProviderMembershipId	object	Loyalty membership identifier assigned by the external loyalty provider's system (or `null` if the value should not be updated).
Points	object	The loyalty points the account has in the loyalty membership (or `null` if the points should not be updated).
ExpirationDate	object	Expiration date of the loyalty membership in UTC timezone in ISO 8601 format (or `null` if the date should not be updated).
Url	object	URL of the loyalty membership (or `null` if the URL should not be updated).
LoyaltyTierId	object	Unique identifier of the loyalty tier (or `null` if the tier should not be updated).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LoyaltyMembershipUpdateParameters",
  "title": "Loyalty membership update parameters",
  "required": [
    "LoyaltyMembershipId"
  ],
  "type": "object",
  "properties": {
    "LoyaltyMembershipId": {
      "type": "string",
      "description": "Unique identifier of the loyalty membership.",
      "format": "uuid"
    },
    "LoyaltyProgramId": {
      "title": "Guid update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/GuidUpdateValue"
        }
      ],
      "description": "Unique identifier of the loyalty program (or `null` if the program should not be updated).",
      "nullable": true
    },
    "State": {
      "title": "Loyalty membership state update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/LoyaltyMembershipStateUpdateValue"
        }
      ],
      "description": "State of the loyalty membership, (or `null` if the state should not be updated).",
      "nullable": true
    },
    "IsPrimary": {
      "title": "Boolean update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/BooleanUpdateValue"
        }
      ],
      "description": "Boolean value defining the primary loyalty membership for the account (or `null` if the value should not be updated).",
      "nullable": true
    },
    "Code": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Code of the loyalty membership. (or `null` if the code should not be updated).",
      "nullable": true,
      "deprecated": true,
      "x-deprecatedMessage": "Use `MembershipNumber` instead."
    },
    "MembershipNumber": {
      "title": "String update value",
      "maxLength": 255,
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Customer-facing membership numbers, e.g., printed on a loyalty card.",
      "nullable": true
    },
    "ProviderMembershipId": {
      "title": "String update value",
      "maxLength": 100,
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Loyalty membership identifier assigned by the external loyalty provider's system (or `null` if the value should not be updated).",
      "nullable": true
    },
    "Points": {
      "title": "Int32 update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/Int32NullableUpdateValue"
        }
      ],
      "description": "The loyalty points the account has in the loyalty membership (or `null` if the points should not be updated).",
      "nullable": true
    },
    "ExpirationDate": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Expiration date of the loyalty membership in UTC timezone in ISO 8601 format (or `null` if the date should not be updated).",
      "format": "date",
      "nullable": true
    },
    "Url": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "URL of the loyalty membership (or `null` if the URL should not be updated).",
      "format": "uri",
      "nullable": true
    },
    "LoyaltyTierId": {
      "title": "Guid update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/GuidNullableUpdateValue"
        }
      ],
      "description": "Unique identifier of the loyalty tier (or `null` if the tier should not be updated).",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "LoyaltyMembershipUpdateParameters"
}