curl --request DELETE \
--url https://{cluster}.voucherify.io/management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} \
--header 'X-Management-Id: <api-key>' \
--header 'X-Management-Token: <api-key>'{
"code": 401,
"message": "Unauthorized",
"key": "unauthorized"
}{
"code": 402,
"message": "Payment required",
"details": "Your current plan does not include a feature required to perform this operation.",
"key": "missing_required_feature"
}{
"code": 404,
"message": "Resource not found",
"details": "Cannot find project with id proj_2F3txY7"
}Delete Metadata Schema
Deletes permanently the metadata schema.
In standard metadata schemas, this endpoint removes permanently all definitions. The standard metadata schemas are:
- Campaign
- Voucher
- Publication
- Redemption
- Product
- Customer
- Order
- Order line item
- Loyalty Tier
- Promotion Tier
- Earning rule
- Reward
If you want to delete only one definition, use the Update Metadata Schema endpoint. In the request, provide the "deleted": true pair in the definition object. This definition will be moved to Removed definitions.
If you want to create a new standard metadata schema, use the Create Metadata Schema endpoint.
🚧 Metadata Purging
This endpoint deletes permanently the metadata schemas only. However, it does not purge the metadata from associated entities, so the metadata added to those entities will remain.
If you want to purge metadata from the entities:
- Remove all the definitions you want to purge. You can do this either in Voucherify Project Settings > Metadata Schema tab or with the Update Metadata Schema endpoint.
- In Voucherify Project Settings > Metadata Schema tab, go to the relevant metadata schema.
- In Removed definitions, click the bin button next to the definitions whose metadata you want to purge from entities. Note:
- This is an asynchronous action. You will be notified when it has been completed.
- You cannot purge metadata for the Redemption and Publication schemas.
- Use the Delete Metadata Schema request to delete the metadata schema from Voucherify.
📘 Metadata Documentation
Read the Getting Started with Metadata and Metadata Mapping articles to learn how metadata work in Voucherify.
curl --request DELETE \
--url https://{cluster}.voucherify.io/management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} \
--header 'X-Management-Id: <api-key>' \
--header 'X-Management-Token: <api-key>'{
"code": 401,
"message": "Unauthorized",
"key": "unauthorized"
}{
"code": 402,
"message": "Payment required",
"details": "Your current plan does not include a feature required to perform this operation.",
"key": "missing_required_feature"
}{
"code": 404,
"message": "Resource not found",
"details": "Cannot find project with id proj_2F3txY7"
}Path Parameters
Provide the unique identifier of the project.
"proj_TrlkLiH4"
Provide the unique identifier of the metadata schema.
"ms_f0r4hm3ta6a4a5ch3ma"
Response
Returns no content if the metadata schema has been successfully deleted.
Was this page helpful?