Rewards

Move reward back to draft

Changed on
<Info>

<Badge color="gray">Documentation in progress</Badge>

This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact Voucherify support or your Technical Account Manager.

</Info>

Moves the reward back to the DRAFT status. Allowed only from ACTIVE status; other transitions return 400 invalid_state_transition. A reward assigned to a program that is not in DRAFT cannot be drafted (423 resource_locked, key connected_non_draft_program). This endpoint takes no request body.

post/v2/loyalties/rewards/{rewardId}/draft

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/rewards/{rewardId}/draft
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or HTTP bearer

Response

The drafted 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 required

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

end_datestring date-time nullable required

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 required

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"
      }
    ]
  }
}

Changes

  • v2ec801ade260dRevision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      deleted the path request parameter rewardId

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added to the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

  • v2f95b50556c93Revision changes
    • breaking

      added the new path request parameter rewardId

    • info

      removed from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status