Loyalty User Recipients

Description

The loyaltyUserRecipients endpoint is used to retrieve or manage the list of recipients associated with a user's loyalty account. This endpoint can be used to view, add, or update individuals who are eligible to receive benefits, rewards, or communications under a user's loyalty program.

Request

Endpoint

/ui/v1/loyaltyUserRecipients

Method

POST

Content-Type: application/json

Request Body

{
    "userId": "1009",
    "recordStatus": {
        "name": "ACTIVE"
    }
}

Response

{
    "records": [
        {
            "id": 11,
            "createdDateTime": 1751897534000,
            "lastUpdatedDateTime": null,
            "userId": 1009,
            "recipientNickname": "CAdmin",
            "recipientLastName": "MEUS",
            "recipientLoyaltyRewardsNumber": 10000000000003,
            "recordStatus": {
                "value": "Active",
                "name": "ACTIVE"
            },
            "useThisRecipientAsDefault": false,
            "message": null
        }
    ],
    "recordCount": null,
    "message": null
}

Updated As Of Version 6.6.x