How can I create custom errors?

Content:

Now you can define custom error messages per Validation Rule which are going to be returned via an API Response when code validation or redemption fails due to the request not meeting validation rule criteria.

Additionally, you can specify  a fallback error message that will be used when there is no error message defined for the particular rule.
Note 💡
Custom error messages are by default visible only in the API response to the given request. Just like in the case of other Voucherify objects, you are free to decide how you would like to display them to your audience.
If you are new to the idea of API-first platforms, visit this article to learn more.
You can define your custom error message both from our API or our Dashboard.

Dashboard 👋

You may create your custom error messaging in the Validation Rules section or while creating a campaign. 

If you are not yet familiar with the concept of validation rules, visit this article to get started.

Let's go to the Validation Rules section.

Validation Rules section

First, you may establish a default fallback error message applicable to all validation rule errors that have not been defined separately. 

Creating a general fallback message

Next, you can add a unique error message for each validation rule.

For instance, you may create a campaign only for customers who have been with your company for a year. If customers outside of the "1-year anniversary" customer segment attempted at redeeming such voucher, Voucherify would block the attempt and will return a custom error message (e.g. "You do not meet segment criteria" or " You are not a "1-year anniversary" customer").

creating error message from the Dashboard

API 🖥️

You can also create custom error messages programmatically.

Go here to learn more details. 

The content of the custom error message is going to be returned in  error object under message property.
If you don't specify any error message for a Validation Rule then the  error property will not be included in the API response.

Here is an exemplary API response containing the custom error message:

Custom error message example

Still need help? Contact Us Contact Us