Metadata Definition
Metadata is a custom, additional data added to data objects (data about data) to create attributes not available by default.
In Voucherify, you can use metadata to add custom information to different built-in objects to make them more specific for your use cases. You can attach multiple metadata properties to a single object. For example, you can attach a birthday date, gender, preferences, and occupation to a customer object. Then, when a new customer record is created in Voucherify, it can be enhanced with this data, allowing you to quickly build segments and redemption rules based on these custom attributes.
What is nested metadata?
To extend your customization capabilities and make developers' jobs easier, you can also use nested objects. For example, you may create a new nested object ‘payment’ and add several nested properties, such as ‘payment_method’, ‘payment_channel’, or ‘currency’, and attach it to the Redemption object.
You can also create metadata in the form of an array, which means that more than one value per metadata property is allowed. Imagine that you have a fitness app, and you want to reward customers with 25 loyalty points if they finish race 1, race 2, and race 3. Then, in the metadata property ‘races_completed’, you can enumerate all the races needed for the points assignment. Depending on the property type, you can fine-grain your data even more by building filters based on time, value, and more.
How to add metadata in Voucherify?
You most likely store your data in an SQL database or a CRM system. To use this data in Voucherify, you need to transfer it to us in a format that our API will understand. We can call this process data synchronization. To give Voucherify a heads-up about what data we can expect, it is crucial that you first create metadata definitions in the Dashboard. This way, you ensure that Voucherify will recognize the data sent to us via API integration with your data system. This data sync allows you to define metadata types such as text, numbers, flags, and dates. Besides, you can mark each property as either obligatory or optional. Text and number fields come with an extra layer of customization – advanced filters that let you create metadata properties equal, lesser, or bigger than a defined number or attribute.
What are some common examples of metadata?
The following overview should give you a better idea of how you can use metadata in your own context.
Here are some examples of metadata for the transport and travel industry:
- If a customer is traveling with children, give a 10% off the trip cost.
- If a customer booked a night ride (11 pm to 5 am) between 9 am and 11 am, add 25$ to the customer’s gift card.
- If a customer booked a trip to London or Brighton, offer a 15% discount on nearby car rental services.
Here are some ideas for online retailers:
- If a customer purchases a product from the Accessories category, give a 5% discount if he/she has a product from the iPhone category. Discount is applicable to accessories only.
- If a customer’s shipping address is in Hamburg, add free shipping to the order.
- If a customer purchases products in the size L, apply a 5% discount to the order.
Ideas for software vendors:
- If a customer is a non-profit organization, enable premium features for free.
- If a customer renews a subscription, give 10% off the next billing period.
- If a customer exceeds the usage limits, offer an automatic 10% off for the upgrade.
Visit our Help Center to learn more about adding and using metadata in your Voucherify projects.