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 and type are required. Depending on type, either material or digital must be provided (not both). Referenced campaigns (for digital rewards) or products/SKUs (for material rewards) must exist.

POST /v2/loyalties/rewards

Create a reward

cURL

curl --request POST \
  --url https://api.voucherify.io/v2/loyalties/rewards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
{
  "name": "<string>",
  "material": {
    "product": {
      "id": "<string>"
    },
    "sku": {
      "product_id": "<string>",
      "id": "<string>"
    }
  },
  "digital": {
    "discount_coupons": {
      "campaign_id": "<string>"
    },
    "gift_vouchers": {
      "campaign_id": "<string>",
      "balance": 1
    }
  },
  "metadata": {}
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "object": "<string>",
  "material": {
    "product": {
      "id": "<string>"
    },
    "sku": {
      "product_id": "<string>",
      "id": "<string>"
    }
  },
  "digital": {
    "discount_coupons": {
      "campaign_id": "<string>"
    },
    "gift_vouchers": {
      "campaign_id": "<string>",
      "balance": 1
    }
  }
}

{
  "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

Payload for creating a reward.

name · string · required

Reward display name.

Required string length: 1 - 200

type · enum<string> · required

Reward type. Determines which sub-configuration is required.

Available options: MATERIAL, DIGITAL

status · enum<string>

Initial status. Defaults to DRAFT when omitted.

Available options: DRAFT, ACTIVE

material · object | null

Required when type is MATERIAL. Must be null/absent when type is DIGITAL.

Show child attributes

digital · object | null

Required when type is DIGITAL. Must be null/absent when type is MATERIAL.

Show child attributes

metadata · object | null

Optional key-value metadata.

Response

200

application/json

Created reward.

Reward resource representation.

id · string · required

Unique reward identifier.

name · string · required

Reward display name.

type · enum<string> · required

Reward type.

Available options: MATERIAL, DIGITAL

status · enum<string> · required

Current lifecycle status.

Available options: ACTIVE, DRAFT, INACTIVE, DELETED

metadata · object · required

Key-value metadata.

created_at · string<date-time> · required

ISO 8601 creation timestamp.

updated_at · string<date-time> | null · required

ISO 8601 last-update timestamp. Null if never updated.

object · string · required

Allowed value: "reward"

material · object

Material configuration. Present only when type is MATERIAL.

Show child attributes

digital · object

Digital configuration. Present only when type is DIGITAL.

Show child attributes