Claim Reward

This API allows the user to claim the reward.

๐Ÿ‘

Note

For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Default access group

Resource information

URI/api_gateway/rewards/core/v1/reward/claim
HTTP MethodPUT
PaginationNo
Batch supportNo
Rate limit informationNone

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/user/reward/claim

Request body parameters

Parameter NameData TypeDescription
Brand ID*StringUnique identifier of the brand. Ex: 29
Reward ID*StringUnique identifier of the reward. Ex: 28359
OwnerType*EnumModule for which the reward was created. Supported values: Loyalty program, Milestones, Campaigns, Journeys, Goodwill.
OwnerID*StringUnique identifier of the owner to claim the reward. Ex:12345678
{
    "brandId": 29 ,
    "rewardId":28359,
    "ownerType":"CAMPAIGNS",
    "ownerId":"12345678"
}

Response parameters

ParameterData TypeDescription
successBooleanIndicates if the reward claim was successful
codeIntegerStatus code associated with the reward claim
messageStringDescription of the error message.
idIntegerUnique identifier of the reward.
{
    "status": {
        "success": true,
        "code": 6013,
        "message": "Reward claimed successfully"
    },
    "reward": {
        "id": 28359
    }
}
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!