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>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

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

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

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

Create 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.

Creates a new reward. name, type and costs are required. When type is MATERIAL the material object is required and digital must be null; when type is DIGITAL the digital object is required and material must be null. The reward can be created directly in DRAFT (default) or ACTIVE status. When validity_hours is not provided it defaults to { "type": "ANY_TIME" }.

POST

loyalties

rewards

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>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

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

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

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<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

Body

application/json

Request body for creating a reward. When type is MATERIAL, material is required and digital must be null; when type is DIGITAL, digital is required and material must be null.

name

string

required

Display name of the reward.

Required string length: 1 - 200

type

enum<string>

required

Reward type. MATERIAL rewards deliver a product or SKU; DIGITAL rewards deliver discount coupons, gift vouchers or loyalty card points.

Available options:

MATERIAL,

DIGITAL

costs

object[]

required

Point costs of the reward. Each cost defines the points to spend on a specific card definition, optionally guarded by rules.

Required array length: 1 - 10 elements

Show child attributes

status

enum<string>

Initial status of the reward. Defaults to DRAFT behavior when omitted.

Available options:

DRAFT,

ACTIVE

validity_hours

object | null

Hours during which the reward can be purchased. Defaults to { "type": "ANY_TIME" } when omitted or null.

Show child attributes

start_date

string<date-time> | null

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

end_date

string<date-time> | null

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

material

object | null

Material reward definition. Required when type is MATERIAL; must be null when type is DIGITAL.

Show child attributes

digital

object | null

Digital reward definition. Required when type is DIGITAL; must be null when type is MATERIAL.

Show child attributes

refunds

object | null

Refund policy for the reward. Defaults to { "type": "NONE" } when omitted.

Show child attributes

metadata

object | null

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

Response

The created 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 27, 2026

⌘I

Introduction

Endpoints

Events

Create a reward

Authorizations

Body

Response