Programs

Create program

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>

Creates a new loyalty program. The program can be created with status DRAFT (default) or ACTIVE. When created as ACTIVE, the program must be connected to at least one active card definition and at least one active earning rule (provided via card_definitions and earning_rules arrays), otherwise the request is rejected with 423 Locked (keys missing_active_card_definition / missing_active_earning_rule). Optionally assigns card definitions, earning rules, rewards and tier structures in the same request.

post/v2/loyalties/programs

Request

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

Request body

namestring required

Program name.

start_datestring date-time nullable

Program validity start date, in ISO 8601 date-time format.

end_datestring date-time nullable

Program validity end date, in ISO 8601 date-time format.

status'ACTIVE' | 'DRAFT' nullable

Initial program status. Only ACTIVE and DRAFT are allowed at creation. Defaults to DRAFT.

metadataobject nullable

Arbitrary key-value metadata. Validated against the vl_program metadata schema definition of the project. Defaults to {}.

Example request

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

Response

Program created. Response includes the ids of resources assigned during creation.

idstring

Unique program identifier.

namestring

Program name.

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

Program status.

start_datestring date-time nullable

Program validity start date (ISO 8601), or null when not set.

end_datestring date-time nullable

Program validity end date (ISO 8601), or null when not set.

metadataobject

Arbitrary key-value metadata. Defaults to {}.

created_atstring date-time

Creation timestamp (ISO 8601).

updated_atstring date-time nullable

Last update timestamp (ISO 8601), or null when never updated.

object'program'

Object type marker.

Changes

  • v2d29b33490051Revision changes
    • breaking

      added to the ////// request property allOf list

    • breaking

      added to the ////// request property allOf list

    • breaking

      added to the ////// request property allOf list

    • breaking

      the ////// request property type changed from object to no type

    • breaking

      the ////// request property type changed from object to no type

    • breaking

      the ////// request property type changed from object to no type

    • warning

      removed the request property ///////

    • warning

      removed the request property ///////

    • warning

      removed the request property ///////

  • v2be14b3318eb3Revision changes
    • breaking

      added the new required request property ///////

    • breaking

      added the new required request property ///////

    • breaking

      added the new required request property ///////

    • breaking

      the ////// request property type changed from no type to object

    • breaking

      the ////// request property type changed from no type to object

    • breaking

      the ////// request property type changed from no type to object

    • warning

      removed from the ////// request property allOf list

    • warning

      removed from the ////// request property allOf list

    • warning

      removed from the ////// request property allOf list