Custom Reward

Get CustomRewards of an entity

This endpoint retrieves CustomReward associated with the given entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/custom-reward

Path parameters

entityId*string

userId*string

Header parameters

Response

200400401500

Successful response

Body

application/json

successboolean

Example: true

dataCustomRewardUserMapping (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/custom-reward', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

200400401500

{
  "success": true,
  "data": {
    "userId": "text",
    "rewardId": "text",
    "entityId": "text",
    "createdAt": "2024-11-21T07:09:48.047Z"
  }
}

Add custom reward to user

Add a custom reward to a user in a specific entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/{rewardId}

Path parameters

entityId*string

userId*string

rewardId*string

Header parameters

Response

200400401500

Successful response

Body

application/json

successboolean

Example: true

dataCustomRewardUserMapping (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/{rewardId}', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

200400401500

{
  "success": true,
  "data": {
    "userId": "text",
    "rewardId": "text",
    "entityId": "text",
    "createdAt": "2024-11-21T07:09:48.047Z"
  }
}