For AI agents: visit https://docs.vouchery.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Vouchery.ioAPI ReferenceUser GuidesCommunity Discussions
HomeUser GuidesRecipesAPI ReferenceProduct UpdatesCommunity Discussions
API ReferenceUser GuidesCommunity DiscussionsJoin our SlackGet SupportLog InVouchery.io
API Reference
Join our SlackGet SupportLog In

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 campaignget
    • Get all invalid redemptionsget
    • Export invalid redemptions within date rangeget
  • Redemptions
    • Get not cancelled redemptions for a campaignget
    • Get cancelled redemptions for a campaignget
    • Cancel redemption by transaction IDdel
    • Get not cancelled redemptionsget
    • Get cancelled redemptionsget
    • Confirm a redemption by transaction IDput
    • Export redemptions within date rangeget
    • Get a redemption by transaction_idget
    • Cancel redemption by redemption IDdel
    • Get a redemption by redemption IDget
    • Update redemption by redemption IDput
    • Confirm a redemption by redemption IDput
    • Get all redemptions for voucherget
    • Create a redemptionpost

Customer MANAGEMENT

  • Customers
    • Get all customersget
    • Create a customerpost
    • Find customers with segmentpost
    • Import your own customerspost
    • Delete a customerdel
    • Get a customerget
    • Update a customerput
    • Count customers by categoriesput
    • Get available vouchers from all campaignsget
    • Customer birthday notificationpost
    • Remove customer from segmentdel
    • Add customer to segmentput
    • Get redemptions performed by a customerget
    • Remove (unassign) vouchers from a customerdel
    • Get vouchers assigned to a customerget
    • Assign vouchers to a customerput
    • Get vouchers assigned to a customer with more detailsget

promo campaigns

  • Excluded Products
    • Get all excluded productsget
    • Create a excluded productpost
    • Delete a excluded productdel
    • Update a excluded productput
  • Campaigns
    • Get all campaignsget
    • Create a campaignpost
    • This is fake endpoint to describe variant of POST /api/v2.1/campaignspost
    • Get aggregated (grouped by day) statistics for all campaigns or for specified campaignget
    • This is fake endpoint to describe variant of POST /api/v2.1/campaignspost
    • Get stats for all campaignsget
    • Get sub campaigns by paramsget
    • 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 campaigndel
    • Get stats for single campaignget
    • Get a campaignget
    • Update a campaignput
    • 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 statsget
    • Get total campaign statsget
    • Get a campaign's vouchers QR codesget
    • Get main campaigns with children by paramsget
    • Get a main campaignget
  • Categories
    • Get all categoriesget
    • Create a categorypost
    • Delete a categorydel
    • Get a categoryget
    • Update a categoryput
  • Rewards
    • Get all rewards for a campaignget
    • Create a campaign rewardpost
    • This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewardspost
    • This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewardspost
    • This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewardspost
    • This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewardspost
    • This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewardspost
    • This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewardspost
    • This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewardspost
    • This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewardspost
    • Delete a rewarddel
    • Get a rewardget
    • Update a rewardput
    • 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 rewardpost
    • This is fake endpoint to describe variant of POST /api/v2.1/triggers/{trigger_id}/rewardspost
    • This is fake endpoint to describe variant of POST /api/v2.1/triggers/{trigger_id}/rewardspost
    • This is fake endpoint to describe variant of POST /api/v2.1/triggers/{trigger_id}/rewardspost
    • This is fake endpoint to describe variant of POST /api/v2.1/triggers/{trigger_id}/rewardspost
  • Rules
    • Get all rules for a campaignget
    • Create a rulepost
    • This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rulespost
    • This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rulespost
    • This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rulespost
    • This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rulespost
    • This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rulespost
    • This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rulespost
    • This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rulespost
    • This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rulespost
    • This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rulespost
    • Delete a ruledel
    • Get a ruleget
    • Update a ruleput
    • 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 campaignpost
    • Get all vouchers for a campaignget
    • Create a voucherpost
    • Batch create voucherspost
    • Batch create vouchers for all customers in given categoriespost
    • Batch create vouchers for customers CSV filepost
    • Distribute vouchers for a campaignget
    • Expire a list of voucherspost
    • Export vouchersget
    • Import your own voucherspost
    • Find a voucher by campaign metadataget
    • Delete a voucherdel
    • Get voucher by codeget
    • Expire a voucherput
    • Get voucher by code in extended versionget
    • Hide a voucherput
    • Mark voucher as distributedput
    • Unhide a voucherput
    • Validate voucherput

Referral Program

  • Referral Program API

LOYALTY PROGRAM API

  • Loyalty Program
    • Customers bulk loyalty points changepost
    • Exchange loyalty points for a voucherpost
    • Grant loyalty points to customerpost
    • Customer's loyalty points activity log.get
    • Customer's loyalty points expiration list.get
    • Revoke customer's loyalty pointspost
    • Transactions
      • Create transactionpost

Automation API

  • Workflows
    • Available eventsget
    • List workflowsget
    • Create a workflowpost
    • Delete a workflowdel
    • Get a workflowget
    • Update a workflowpatch
    • Activate a workflowpost
    • Deactivate a workflowpost
  • Triggers and events
    • Invoke custom trigger - run eventpost
    • Get all triggers for the projectget
    • Send custom eventpost
    • Create a triggerpost
    • This is fake endpoint to describe variant of POST /api/v2.1/triggerspost
    • This is fake endpoint to describe variant of POST /api/v2.1/triggerspost
    • This is fake endpoint to describe variant of POST /api/v2.1/triggerspost
    • This is fake endpoint to describe variant of POST /api/v2.1/triggerspost
    • This is fake endpoint to describe variant of POST /api/v2.1/triggerspost
    • This is fake endpoint to describe variant of POST /api/v2.1/triggerspost
    • Delete a triggerdel
    • Get a triggerget
    • Update a triggerput
    • 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 integrationsget
  • MEWS
    • Set MEWS integrationput
    • MEWS webhookpost

Webhooks Event Subscriptions

  • Configuring & testing Webhooks
  • Subscriptions
    • Get all subscriptions for a projectget
    • Create a subscriptionpost
    • Delete a subscriptiondel

ADMIN Management

  • Auth
    • Disable user MFApost
    • Enable user MFApost
    • User sign in with MFA.post
    • Verifies MFA after enabling.post
    • User token refresh.post
  • Register new account
    • Register new accountpost
  • Companies Management - for super admin
    • Get all companiesget
    • Update company detailsput
    • Create a companypost
    • Get a companyget
    • Update a companyput
  • Projects Management - for super admin
    • Get all projectsget
    • Update project settingsput
    • Create a projectpost
    • Get a projectget
    • Update a projectput
  • Queue-Tasks
    • Get all queue tasksget
    • Get a queue task by task idget
  • Company
  • Project
  • Users
    • Get all usersget
    • Get information about current user and projectget
    • Get all users within a projectget
    • 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 deprecatedget
    • Update a userput
    • Deactivate/Re-activate userput
  • UI
    • Health checkget
    • User sign inpost
    • Reset Api Keyput
    • Password reset - request reset tokenpost
    • Password reset - set new passwordput
    • Password reset - request reset tokenpost
    • Password reset - set new passwordput
    • User sign inpost
Powered by 
  1. ADMIN Management

Company

Updated about 2 hours ago


Get a queue task by task id
Project
Did this page help you?

Updated about 2 hours ago


Get a queue task by task id
Project
Did this page help you?