The Voucherify Developer Hub

Welcome to the Voucherify developer hub. You'll find comprehensive guides and documentation to help you start working with Voucherify as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Metadata (custom fields)

Metadata enables you to extend Voucherify objects with custom attributes. You can use them just as built-in fields for customer segment filters, validation rules, and reporting purposes. Metadata works with campaigns, vouchers, customers, SKUs, products, redemptions.

Schema validator

Voucherify will take care of metadata integrity. This is achieved by metadata schema validator. It allows you to define fields types, including:

  • text
  • number
  • boolean
  • date
  • date time

Additionally, each field can be marked as optional. Also, text and number can restricted by the following filters:

  • text - min/max/exact length, is equal to
  • number - less than, less than or equal to, greater than, greater or equal to, equal to, not equal to

Each project can have a separate metadata schema

Bulk updates

Use cases

Metadata enable you to create flexible promotion scenarios with data from your CRM/e-commerce infrastructure:

  • validate redemptions based on custom attributes
  • filter out customers in segments (e.g. users who signed up for the newsletter before a given date) and use them for validation rules
  • run distributions based on custom customer attributes
  • enforce that new campaigns to have proper identifiers provided for reporting

Updated 8 months ago

Metadata (custom fields)

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.