v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB

Rewards

Create a new custom voucher

This endpoint allows clients to specify the money value to be used for the voucher, overriding standard reward calculation logic. ⚠️ Only applicable to Simple rewards. To generate standard voucher from a reward, please use POST /create-voucher. ⚠️ This endpoint is disabled by default. Please contact the CareCloud administrator to allow usage of this method.

post/rewards/{reward_id}/actions/create-custom-voucher

Path parameters

reward_idstring required

The unique ID of the reward.

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Request body

customer_idstring required

The unique ID of the customer.

valueinteger required

Parameter represents money value of the voucher.

codestring

Code of the voucher.

notestring

The voucher note.

Example request

{
  "customer_id": "8ea2591121e636086a4a9c0992",
  "value": 754,
  "code": "w7TU7KfeE1",
  "note": "Use before 28.03.2024 get another one for free"
}

Response

Created

Example response

{
  "data": {
    "voucher_id": "82d0f9d976dee39aacd13dc7ea"
  }
}