Creates a new metadata (custom attribute) schema for a given resource.
The schema consists of a set of key-value pairs to customize Voucherify resources.
You can nest your object within a standard metadata schema, e.g. within a campaign or customer schema. However, your nested object can't include another nested object. The standard metadata schemas are:
- Campaign
- Voucher
- Publication
- Redemption
- Product
- Customer
- Order
- Order line item
- Loyalty Tier
- Promotion Tier
- Earning rule
- Reward
Use this endpoint to define a metadata schema of a given resource for the first time. Once you configure a metadata schema for a given related_object
, use the PUT Update metadata schema endpoint to either update or add new metadata key-value pairs. For example, use this endpoint to define a metadata schema for related_object: campaign
for the first time. If you want define a new metadata property for campaign
, use the PUT Update metadata schema endpoint.
Metadata Documentation
Read the Getting Started with Metadata and Metadata Mapping articles to learn how metadata work in Voucherify.