GuidesHelp CenterRelease notesRoadmap
Guides

API version upgrades

Keep track of changes and upgrades to the Voucherify API.

Suggest Edits

Your API version controls the API and webhook behavior you see (e.g., what properties you see in responses, what parameters you’re permitted to send in requests, etc.). Your version is set the first time you make an API request. When we change the API in a backwards-incompatible way, we release a new dated version, but to avoid breaking your code, we don’t change your version until you’re ready to upgrade.

How can I upgrade my API?

If you’re running an older version, you’ll want to upgrade to take advantage of the latest API. For changing your API version, go to your Project Settings and click Upgrade to the latest API version.

Upgrade API

Changes which Voucherify considers to be backwards-compatible

  • Adding new API resources.
  • Adding new optional request parameters to existing API methods.
  • Adding new properties to existing API responses.
  • Changing the order of properties in existing API responses.
  • Changing the length or format of object IDs or other opaque strings.
  • Adding new event types. It means that your webhook listener should gracefully handle unfamiliar events types.

API changelog

VersionDescription
v2017-04-05
version deprecated		- Responses from the voucher and campaign listing methods were moved to the new object structure. Methods will now render specific properties for a total count and an array of objects.
- Introduced validation for listing parameters: limit and page. A limit can range between 1 and 100 items.
- Get voucher/campaign methods render validation rules related to the voucher object. They can be inherited from a campaign.
- Created an API method for getting a campaign identified by name.
v2017-04-20
version deprecated		Response from the voucher publish method was moved to the new object structure. Returned voucher details are wrapped by transaction object describing publication event:
{ "id": "pub_whQzIndYoyZoqiLEKN0s04GK", "object": "publication", "created_at": "2017-04-20T13:18:01Z", "customer_id": "cust_mOjhGypfbqch0v3DpAA9LDXj", "tracking_id": "janusz", "channel": "API", "metadata": { "test":true }, "voucher": {} }
v2018-08-01This version introduces a new model for building Validation Rules. The extended mechanism gives an advanced configuration for making promo conditions.

The modifications in this version affect the following API methods:

- List Promotion Tiers: replaced an object describing conditions by a list of records describing an association between rule and tier - validation_rule_assignments
- List Promotion Tiers for campaign - as above
- Promotion Tier Object - as above
- Validation Rule Object - structure reorganized to handle advanced rules
- Validation Rule Assignment Object - added object describing a relation between rules and linked promotions
- Validation Rules - modified data model

The mechanics and details of Validation Rules builder are described in the Help Center.
Webhooks v2024-01-01In v20231205 release, a new version of webhooks was introduced. The new webhooks are available for distribution and the events listed in Project settings. There, you can switch from the old v2018-01-01 webhook version to the new one. The accounts created after the v20231205 release can use only the new version.

📘

Release Notes

Visit our Help Center to learn more about the latest Release Notes and new features.

Updated 3 days ago