Error

A valid request URL is required to generate request examples

{
  "id": "<string>",
  "name": "<string>",
  "validity_hours": {
    "daily": [
      {
        "days_of_week": [
          3
        ],
        "start_time": "09:00",
        "end_time": "17:00"
      }
    ]
  },
  "refunds": {},
  "costs": [
    {
      "id": "<string>",
      "rules": {
        "logic": "<string>"
      },
      "spending": [
        {
          "points": 123,
          "card_definition_id": "<string>"
        }
      ]
    }
  ],
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "object": "<string>",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "material": {
    "product": {
      "id": "<string>"
    },
    "sku": {
      "product_id": "<string>",
      "id": "<string>"
    }
  },
  "digital": {
    "discount_coupons": {
      "campaign_id": "<string>"
    },
    "gift_vouchers": {
      "campaign_id": "<string>",
      "balance": 123
    },
    "loyalty_card_points": {
      "points": 123,
      "card_definition_id": "<string>"
    }
  },
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>"
}

Deactivate a reward

⚠️ BETA endpoint

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

Moves the reward to the INACTIVE status. Allowed only from ACTIVE status; other transitions are rejected with a conflict error. This endpoint takes no request body.

POST

loyalties

rewards

{rewardId}

deactivate

Deactivate a reward

curl --request POST \
  --url {protocol}://{host}/v2/loyalties/rewards/{rewardId}/deactivate \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

{
  "id": "<string>",
  "name": "<string>",
  "validity_hours": {
    "daily": [
      {
        "days_of_week": [
          3
        ],
        "start_time": "09:00",
        "end_time": "17:00"
      }
    ]
  },
  "refunds": {},
  "costs": [
    {
      "id": "<string>",
      "rules": {
        "logic": "<string>"
      },
      "spending": [
        {
          "points": 123,
          "card_definition_id": "<string>"
        }
      ]
    }
  ],
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "object": "<string>",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "material": {
    "product": {
      "id": "<string>"
    },
    "sku": {
      "product_id": "<string>",
      "id": "<string>"
    }
  },
  "digital": {
    "discount_coupons": {
      "campaign_id": "<string>"
    },
    "gift_vouchers": {
      "campaign_id": "<string>",
      "balance": 123
    },
    "loyalty_card_points": {
      "points": 123,
      "card_definition_id": "<string>"
    }
  },
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

X-App-Id

string

header

required

X-App-Token

string

header

required

Path Parameters

string

required

Unique reward identifier, prefixed with lrew_.

Pattern: ^lrew_[a-f0-9]+$

Response

The deactivated reward.

A reward, as returned by the API.

string

required

Unique reward identifier, prefixed with lrew_.

Pattern: ^lrew_[a-f0-9]+$

name

string

required

Display name of the reward.

type

enum<string>

required

Reward type.

Available options:

MATERIAL,

DIGITAL

status

enum<string>

required

Current lifecycle status of the reward.

Available options:

ACTIVE,

DRAFT,

INACTIVE,

DELETED

validity_hours

object

required

Hours during which the reward can be purchased. Always present; defaults to { "type": "ANY_TIME" }.

Show child attributes

refunds

object

required

Refund policy. Always present; defaults to { "type": "NONE" }.

Show child attributes

costs

object[]

required

Point costs of the reward. Empty array when no costs are defined.

Show child attributes

metadata

object

required

Arbitrary key-value metadata attached to the reward. Empty object when not set.

created_at

string<date-time>

required

Timestamp when the reward was created (ISO-8601).

object

string

required

Object type marker; always reward.

Allowed value: "reward"

start_date

string<date-time> | null

Date from which the reward is available, or null when not set.

end_date

string<date-time> | null

Date until which the reward is available, or null when not set.

material

object

Material reward definition. Present only when type is MATERIAL; omitted otherwise.

Show child attributes

digital

object

Digital reward definition. Present only when type is DIGITAL; omitted otherwise.

Show child attributes

updated_at

string<date-time> | null

Timestamp when the reward was last updated (ISO-8601), or null when never updated.

Last modified on July 13, 2026

Activate a reward Move a reward back to draft

⌘I

Card Definitions

Programs

Members

Examine

Earning Rules

Tier Structures

Benefits

Rewards

Deactivate a reward

Authorizations

Path Parameters

Response