Delete Recipient

Description¶

The deleteUserRecipient endpoint allows the deletion of an existing recipient under a user's loyalty account.

Endpoint¶

/ui/v1/deleteUserRecipient

Method¶

POST

Header¶

Content-Type: application/json

Request Body¶

{
    "id": 5,
    "createdDateTime": 1752174889000,
    "lastUpdatedDateTime": null,
    "userId": 696,
    "recipientNickname": null,
    "recipientLastName": "velaatlanta",
    "recipientLoyaltyRewardsNumber": 10000000000004,
    "recordStatus": {
        "value": "Active",
        "name": "ACTIVE"
    },
    "useThisRecipientAsDefault": false,
    "message": null,
    "lastModifiedUserId": "696"
}

Response¶

{
    "id": 5,
    "createdDateTime": 1752174889000,
    "lastUpdatedDateTime": null,
    "userId": 696,
    "recipientNickname": null,
    "recipientLastName": "velaatlanta",
    "recipientLoyaltyRewardsNumber": 10000000000004,
    "recordStatus": {
        "value": "Deleted",
        "name": "DELETED"
    },
    "useThisRecipientAsDefault": false,
    "message": {
        "code": "45",
        "type": {
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "USER_RECIPIENT_DELETION_SUCCESS",
        "parameters": [
            {
                "name": "LAST_NAME",
                "value": "velaatlanta"
            }
        ]
    }
}

Updated As Of Version 6.6.x