Jump to Content
API Reference
User Guides
Community Discussions
Home
User Guides
Recipes
API Reference
Product Updates
Community Discussions
v1.0
v2.0
v2.1
API Reference
User Guides
Community Discussions
Join our Slack
Get Support
Log In
API Reference
Join our Slack
Get Support
Log In
Moon (Dark Mode)
Sun (Light Mode)
Vouchery GO
API Reference
Delete a reward
Search
JUMP TO
Getting Started
Getting Started with Vouchery.io Coupon Promotion API v2.1
Basic concepts
Authentication
Authorization
Pagination
Errors
Changes from version 2.0
Redemptions API
Redemption Walkthrough
Rejected Redemptions Messages
Invalid Redemptions
Get all invalid redemptions for a campaign
get
Get all invalid redemptions
get
Export invalid redemptions within date range
get
Redemptions
Get not cancelled redemptions for a campaign
get
Get cancelled redemptions for a campaign
get
Cancel redemption by transaction ID
delete
Get not cancelled redemptions
get
Get cancelled redemptions
get
Confirm a redemption by transaction ID
put
Export redemptions within date range
get
Get a redemption by transaction_id
get
Cancel redemption by redemption ID
delete
Get a redemption by redemption ID
get
Update redemption by redemption ID
put
Confirm a redemption by redemption ID
put
Get all redemptions for voucher
get
Create a redemption
post
Customer MANAGEMENT
Customers
Get all customers
get
Create a customer
post
Find customers with segment
post
Import your own customers
post
Delete a customer
delete
Get a customer
get
Update a customer
put
Count customers by categories
put
Get available vouchers from all campaigns
get
Customer birthday notification
post
Remove customer from segment
delete
Add customer to segment
put
Get redemptions performed by a customer
get
Remove (unassign) vouchers from a customer
delete
Get vouchers assigned to a customer
get
Assign vouchers to a customer
put
Get vouchers assigned to a customer with more details
get
promo campaigns
Excluded Products
Get all excluded products
get
Create a excluded product
post
Delete a excluded product
delete
Update a excluded product
put
Campaigns
Get all campaigns
get
Create a campaign
post
This is fake endpoint to describe variant of POST /api/v2.1/campaigns
post
Get aggregated (grouped by day) statistics for all campaigns or for specified campaign
get
This is fake endpoint to describe variant of POST /api/v2.1/campaigns
post
Get stats for all campaigns
get
Get sub campaigns by params
get
Get suggestions for new campaign form. For project access scope, teams contains all team names from users. For other scopes teams contains all team names from current user.
get
Delete a campaign
delete
Get stats for single campaign
get
Get a campaign
get
Update a campaign
put
This is fake endpoint to describe variant of PUT /api/v2.1/campaigns/{campaign_id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/campaigns/{campaign_id}
put
Get total campaign stats
get
Get total campaign stats
get
Get a campaign's vouchers QR codes
get
Get main campaigns with children by params
get
Get a main campaign
get
Categories
Get all categories
get
Create a category
post
Delete a category
delete
Get a category
get
Update a category
put
Rewards
Get all rewards for a campaign
get
Create a campaign reward
post
This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewards
post
This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewards
post
This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewards
post
This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewards
post
This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewards
post
This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewards
post
This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewards
post
This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewards
post
Delete a reward
delete
Get a reward
get
Update a reward
put
This is fake endpoint to describe variant of PUT /api/v2.1/rewards/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/rewards/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/rewards/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/rewards/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/rewards/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/rewards/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/rewards/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/rewards/{id}
put
Create a trigger reward
post
This is fake endpoint to describe variant of POST /api/v2.1/triggers/{trigger_id}/rewards
post
This is fake endpoint to describe variant of POST /api/v2.1/triggers/{trigger_id}/rewards
post
This is fake endpoint to describe variant of POST /api/v2.1/triggers/{trigger_id}/rewards
post
This is fake endpoint to describe variant of POST /api/v2.1/triggers/{trigger_id}/rewards
post
Rules
Get all rules for a campaign
get
Create a rule
post
This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rules
post
This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rules
post
This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rules
post
This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rules
post
This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rules
post
This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rules
post
This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rules
post
This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rules
post
This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rules
post
Delete a rule
delete
Get a rule
get
Update a rule
put
This is fake endpoint to describe variant of PUT /api/v2.1/rules/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/rules/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/rules/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/rules/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/rules/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/rules/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/rules/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/rules/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/rules/{id}
put
Vouchers
Generate voucher code for campaign
post
Get all vouchers for a campaign
get
Create a voucher
post
Batch create vouchers
post
Batch create vouchers for all customers in given categories
post
Batch create vouchers for customers CSV file
post
Distribute vouchers for a campaign
get
Expire a list of vouchers
post
Export vouchers
get
Import your own vouchers
post
Find a voucher by campaign metadata
get
Delete a voucher
delete
Get voucher by code
get
Expire a voucher
put
Get voucher by code in extended version
get
Hide a voucher
put
Mark voucher as distributed
put
Unhide a voucher
put
Validate voucher
put
Referral Program
Referral Program API
LOYALTY PROGRAM API
Loyalty Program
Customers bulk loyalty points change
post
Exchange loyalty points for a voucher
post
Grant loyalty points to customer
post
Customer's loyalty points activity log.
get
Customer's loyalty points expiration list.
get
Revoke customer's loyalty points
post
Transactions
Create transaction
post
Automation API
Workflows
Available events
get
List workflows
get
Create a workflow
post
Delete a workflow
delete
Get a workflow
get
Update a workflow
patch
Activate a workflow
post
Deactivate a workflow
post
Triggers and events
Invoke custom trigger - run event
post
Get all triggers for the project
get
Send custom event
post
Create a trigger
post
This is fake endpoint to describe variant of POST /api/v2.1/triggers
post
This is fake endpoint to describe variant of POST /api/v2.1/triggers
post
This is fake endpoint to describe variant of POST /api/v2.1/triggers
post
This is fake endpoint to describe variant of POST /api/v2.1/triggers
post
This is fake endpoint to describe variant of POST /api/v2.1/triggers
post
This is fake endpoint to describe variant of POST /api/v2.1/triggers
post
Delete a trigger
delete
Get a trigger
get
Update a trigger
put
This is fake endpoint to describe variant of PUT /api/v2.1/triggers/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/triggers/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/triggers/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/triggers/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/triggers/{id}
put
This is fake endpoint to describe variant of PUT /api/v2.1/triggers/{id}
put
INTEGRATIONS
Get list of project integrations
get
MEWS
Set MEWS integration
put
MEWS webhook
post
Webhooks Event Subscriptions
Configuring & testing Webhooks
Subscriptions
Get all subscriptions for a project
get
Create a subscription
post
Delete a subscription
delete
ADMIN Management
Auth
Disable user MFA
post
Enable user MFA
post
User sign in with MFA.
post
Verifies MFA after enabling.
post
User token refresh.
post
Register new account
Register new account
post
Companies Management - for super admin
Get all companies
get
Update company details
put
Create a company
post
Get a company
get
Update a company
put
Projects Management - for super admin
Get all projects
get
Update project settings
put
Create a project
post
Get a project
get
Update a project
put
Queue-Tasks
Get all queue tasks
get
Get a queue task by task id
get
Company
Project
Users
Get all users
get
Get information about current user and project
get
Get all users within a project
get
Create an user. Invite user.
post
Resend invitation to new user (user who had never sign in)
post
Get a user by id, previously used email is deprecated
get
Update a user
put
Deactivate/Re-activate user
put
UI
Health check
get
User sign in
post
Reset Api Key
put
Password reset - request reset token
post
Password reset - set new password
put
Password reset - request reset token
post
Password reset - set new password
put
User sign in
post
Powered by
Delete a reward
delete
https://admin.sandbox.vouchery.app/api/v2.1/rewards/
{id}
Delete the reward.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
RESPONSE
Click
Try It!
to start a request and see the response here!