Sign in

v18

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01934981.1 MB
Rewards

Update a reward

<Warning>

<Badge color="yellow">BETA endpoint</Badge>

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.

</Warning>

Updates an existing reward. When type is provided as MATERIAL the material object is required and digital must be null; when type is provided as DIGITAL the digital object is required and material must be null.

In DRAFT status all properties can be updated. In ACTIVE/INACTIVE status only the following properties can be updated: name, metadata, refunds, validity_hours, start_date, end_date, costs.

put/v2/loyalties/rewards/{rewardId}

Path parameters

idstring required

Unique reward identifier, prefixed with lrew_.

Request body

namestring

Display name of the reward.

type'MATERIAL' | 'DIGITAL'

Reward type. Can only be changed while the reward is in DRAFT status.

start_datestring date-time nullable

Date from which the reward is available. Must be an ISO-8601 compliant date.

end_datestring date-time nullable

Date until which the reward is available. Must be an ISO-8601 compliant date.

metadataobject nullable

Arbitrary key-value metadata attached to the reward, as a free-form object.

Example request

{
  "validity_hours": {
    "daily": [
      {
        "start_time": "09:00",
        "end_time": "17:00"
      }
    ]
  }
}

Response

The updated reward.

idstring required

Unique reward identifier, prefixed with lrew_.

namestring required

Display name of the reward.

type'MATERIAL' | 'DIGITAL' required

Reward type.

status'ACTIVE' | 'DRAFT' | 'INACTIVE' | 'DELETED' required

Current lifecycle status of the reward.

start_datestring date-time nullable

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

end_datestring date-time nullable

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

metadataobject required

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

created_atstring date-time required

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

updated_atstring date-time nullable

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

object'reward' required

Object type marker; always reward.

Example response

{
  "validity_hours": {
    "daily": [
      {
        "start_time": "09:00",
        "end_time": "17:00"
      }
    ]
  }
}