Add Recipient

Description

The addUserRecipient endpoint allows the creation of a new recipient under a user's loyalty account. This endpoint is used to add an individual who can receive loyalty rewards, communications, or benefits associated with the user’s profile.

Request

Endpoint

/ui/v1/addUserRecipient

Method

POST

Content-Type: application/json

Request Body

{
    "id": 0,
    "recordStatus": {
        "name": "ACTIVE"
    },
    "recipientLastName": "MEUS",
    "recipientLoyaltyRewardsNumber": "10000000000003",
    "recipientNickname": "CAdmin",
    "userId": "1009"
}

Response

{
    "id": 11,
    "createdDateTime": null,
    "lastUpdatedDateTime": null,
    "userId": 1009,
    "recipientNickname": "CAdmin",
    "recipientLastName": "ABCD",
    "recipientLoyaltyRewardsNumber": 10000000000003,
    "recordStatus": {
        "value": "Active",
        "name": "ACTIVE"
    },
    "useThisRecipientAsDefault": false,
    "message": {
        "code": "42",
        "type": {
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "USER_RECIPIENT_CREATION_SUCCESS",
        "parameters": [
            {
                "name": "LAST_NAME",
                "value": "ABCD"
            }
        ]
    }
}

Updated As Of Version 6.6.x