POST
/
v2
/
rewards
/
{reward_id}
/
disable
cURL
curl --request POST \
  --url https://api.loyaltylion.com/v2/rewards/{reward_id}/disable \
  --header 'Authorization: Bearer <token>'
{
  "updated": true,
  "reward": {
    "id": 123
  }
}
This endpoint only supports API and OAuth keys, and requires the write_configuration scope
Disable a reward by its ID. This will immediately prevent it from being redeemed by customers, and it will no longer be shown as an available reward in LoyaltyLion UI components or API responses. This endpoint is idempotent: if the reward is already disabled, this endpoint will return a 200 response, and the updated property in the response will be false.

Authorizations

Authorization
string
header
required

An API key linked to a Program in LoyaltyLion, with a set of permissions (scopes). API keys can be created manually, or acquired through an OAuth2 flow. The API key should be provided as a Bearer token in the Authorization header

Path Parameters

reward_id
integer
required

The ID of the reward to disable

Required range: x >= 1

Response

200
application/json

200

The response is of type object.