Set Recipient As Default

Set Recipient As Default

Description¶

The setUserRecipientAsDefault endpoint is used to designate a specific loyalty recipient as the default for a user’s account. Once set, this default recipient will be automatically pre-selected in future loyalty-related transactions such as point transfers, reward redemptions, or benefit sharing.

This operation helps streamline the user experience by reducing the need to repeatedly select the same recipient for recurring loyalty actions.

Endpoint¶
/ui/v1/setUserRecipientAsDefault
Method¶
POST
Header¶

Content-Type: application/json

Request Body¶

{
    "id": 4,
    "createdDateTime": 1752174723000,
    "lastUpdatedDateTime": null,
    "userId": 692,
    "recipientNickname": null,
    "recipientLastName": "Velaatlanta",
    "recipientLoyaltyRewardsNumber": 10000000000005,
    "recordStatus": {
        "value": "Active",
        "name": "ACTIVE"
    },
    "useThisRecipientAsDefault": false,
    "message": null
}

Response¶

{
    "id": 4,
    "createdDateTime": 1752174723000,
    "lastUpdatedDateTime": null,
    "userId": 692,
    "recipientNickname": null,
    "recipientLastName": "Velaatlanta",
    "recipientLoyaltyRewardsNumber": 10000000000005,
    "recordStatus": {
        "value": "Active",
        "name": "ACTIVE"
    },
    "useThisRecipientAsDefault": false,
    "message": {
        "code": "47",
        "type": {
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "USER_RECIPIENT_SET_DEFAULT_SUCCESS",
        "parameters": [
            {
                "name": "LAST_NAME",
                "value": "Velaatlanta"
            }
        ]
    }
}

Updated As Of Version 6.6.x