updateLoyaltyMemberships
Modify loyalty membership details like points, expiration date, and tier. Enable updates to primary status, state, and external provider IDs for accurate account management.
Instructions
Updates information about the specified loyalty memberships. Note this operation supports Portfolio Access Tokens.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
ChainId | No | Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise. | |
LoyaltyMembershipUpdates | Yes | Loyalty memberships to be updated |
Input Schema (JSON Schema)
{
"additionalProperties": false,
"properties": {
"ChainId": {
"description": "Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise.",
"type": "string"
},
"LoyaltyMembershipUpdates": {
"description": "Loyalty memberships to be updated",
"items": {
"additionalProperties": false,
"properties": {
"Code": {
"description": "Code of the loyalty membership (or null if the code should not be updated)",
"properties": {
"Value": {
"description": "Code of the loyalty membership",
"type": "string"
}
},
"type": "object"
},
"ExpirationDate": {
"description": "Expiration date of the loyalty membership in UTC timezone in ISO 8601 format (or null if the date should not be updated)",
"properties": {
"Value": {
"description": "Expiration date of the loyalty membership in UTC timezone in ISO 8601 format",
"type": "string"
}
},
"type": "object"
},
"IsPrimary": {
"description": "Boolean value defining the primary loyalty membership for the account (or null if the value should not be updated)",
"properties": {
"Value": {
"description": "Boolean value defining the primary loyalty membership",
"type": "boolean"
}
},
"type": "object"
},
"LoyaltyMembershipId": {
"description": "Unique identifier of the loyalty membership",
"type": "string"
},
"LoyaltyProgramId": {
"description": "Unique identifier of the loyalty program (or null if the program should not be updated)",
"properties": {
"Value": {
"description": "Unique identifier of the loyalty program",
"type": "string"
}
},
"type": "object"
},
"LoyaltyTierId": {
"description": "Unique identifier of the loyalty tier (or null if the tier should not be updated)",
"properties": {
"Value": {
"description": "Unique identifier of the loyalty tier",
"type": "string"
}
},
"type": "object"
},
"Points": {
"description": "The loyalty points the account has in the loyalty membership (or null if the points should not be updated)",
"properties": {
"Value": {
"description": "The loyalty points the account has",
"type": "number"
}
},
"type": "object"
},
"ProviderMembershipId": {
"description": "Loyalty membership identifier assigned by the external loyalty provider's system (or null if the value should not be updated)",
"properties": {
"Value": {
"description": "Loyalty membership identifier assigned by external provider",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
},
"State": {
"description": "State of the loyalty membership (or null if the state should not be updated)",
"properties": {
"Value": {
"description": "State of the loyalty membership",
"type": "string"
}
},
"type": "object"
},
"Url": {
"description": "URL of the loyalty membership (or null if the URL should not be updated)",
"properties": {
"Value": {
"description": "URL of the loyalty membership",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"LoyaltyMembershipId"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
}
},
"required": [
"LoyaltyMembershipUpdates"
],
"type": "object"
}