JUMP TOGetting StartedGetting Started with Vouchery.io Coupon Promotion API v2.1Basic conceptsAuthenticationAuthorizationPaginationErrorsChanges from version 2.0Redemptions APIRedemption WalkthroughRejected Redemptions MessagesInvalid RedemptionsGet all invalid redemptions for a campaigngetGet all invalid redemptionsgetExport invalid redemptions within date rangegetRedemptionsGet not cancelled redemptions for a campaigngetGet cancelled redemptions for a campaigngetCancel redemption by transaction IDdeleteGet not cancelled redemptionsgetGet cancelled redemptionsgetConfirm a redemption by transaction IDputExport redemptions within date rangegetGet a redemption by transaction_idgetCancel redemption by redemption IDdeleteGet a redemption by redemption IDgetUpdate redemption by redemption IDputConfirm a redemption by redemption IDputGet all redemptions for vouchergetCreate a redemptionpostCustomer MANAGEMENTCustomersGet all customersgetCreate a customerpostFind customers with segmentpostImport your own customerspostDelete a customerdeleteGet a customergetUpdate a customerputCount customers by categoriesputGet available vouchers from all campaignsgetCustomer birthday notificationpostRemove customer from segmentdeleteAdd customer to segmentputGet redemptions performed by a customergetRemove (unassign) vouchers from a customerdeleteGet vouchers assigned to a customergetAssign vouchers to a customerputGet vouchers assigned to a customer with more detailsgetVoucheryExcluded ProductsGet all excluded productsgetCreate a excluded productpostDelete a excluded productdeleteUpdate a excluded productputCampaignsGet all campaignsgetCreate a campaignpostThis is fake endpoint to describe variant of POST /api/v2.1/campaignspostGet aggregated (grouped by day) statistics for all campaigns or for specified campaigngetThis is fake endpoint to describe variant of POST /api/v2.1/campaignspostGet stats for all campaignsgetGet sub campaigns by paramsgetGet 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.getDelete a campaigndeleteGet stats for single campaigngetGet a campaigngetUpdate a campaignputThis is fake endpoint to describe variant of PUT /api/v2.1/campaigns/{campaign_id}putThis is fake endpoint to describe variant of PUT /api/v2.1/campaigns/{campaign_id}putGet total campaign statsgetGet total campaign statsgetGet a campaign's vouchers QR codesgetGet main campaigns with children by paramsgetGet a main campaigngetCategoriesGet all categoriesgetCreate a categorypostDelete a categorydeleteGet a categorygetUpdate a categoryputRewardsGet all rewards for a campaigngetCreate a campaign rewardpostThis is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewardspostThis is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewardspostThis is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewardspostThis is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewardspostThis is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewardspostThis is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewardspostThis is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewardspostThis is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rewardspostDelete a rewarddeleteGet a rewardgetUpdate a rewardputThis is fake endpoint to describe variant of PUT /api/v2.1/rewards/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/rewards/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/rewards/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/rewards/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/rewards/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/rewards/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/rewards/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/rewards/{id}putCreate a trigger rewardpostThis is fake endpoint to describe variant of POST /api/v2.1/triggers/{trigger_id}/rewardspostThis is fake endpoint to describe variant of POST /api/v2.1/triggers/{trigger_id}/rewardspostThis is fake endpoint to describe variant of POST /api/v2.1/triggers/{trigger_id}/rewardspostThis is fake endpoint to describe variant of POST /api/v2.1/triggers/{trigger_id}/rewardspostRulesGet all rules for a campaigngetCreate a rulepostThis is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rulespostThis is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rulespostThis is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rulespostThis is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rulespostThis is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rulespostThis is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rulespostThis is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rulespostThis is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rulespostThis is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rulespostDelete a ruledeleteGet a rulegetUpdate a ruleputThis is fake endpoint to describe variant of PUT /api/v2.1/rules/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/rules/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/rules/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/rules/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/rules/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/rules/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/rules/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/rules/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/rules/{id}putVouchersGenerate voucher code for campaignpostGet all vouchers for a campaigngetCreate a voucherpostBatch create voucherspostBatch create vouchers for all customers in given categoriespostBatch create vouchers for customers CSV filepostDistribute vouchers for a campaigngetExpire a list of voucherspostExport vouchersgetImport your own voucherspostFind a voucher by campaign metadatagetDelete a voucherdeleteGet voucher by codegetExpire a voucherputGet voucher by code in extended versiongetHide a voucherputMark voucher as distributedputUnhide a voucherputValidate voucherputIntegrationsGet list of project integrationsgetSet MEWS integrationputLOYALTY PROGRAM APILoyalty ProgramCustomers bulk loyalty points changepostExchange loyalty points for a voucherpostGrant loyalty points to customerpostCustomer's loyalty points activity log.getCustomer's loyalty points expiration list.getRevoke customer's loyalty pointspostTransactionsCreate transactionpostAutomation APIWorkflowsAvailable eventsgetList workflowsgetCreate a workflowpostDelete a workflowdeleteGet a workflowgetUpdate a workflowpatchActivate a workflowpostDeactivate a workflowpostTriggers and eventsInvoke custom trigger - run eventpostGet all triggers for the projectgetSend custom eventpostCreate a triggerpostThis is fake endpoint to describe variant of POST /api/v2.1/triggerspostThis is fake endpoint to describe variant of POST /api/v2.1/triggerspostThis is fake endpoint to describe variant of POST /api/v2.1/triggerspostThis is fake endpoint to describe variant of POST /api/v2.1/triggerspostThis is fake endpoint to describe variant of POST /api/v2.1/triggerspostThis is fake endpoint to describe variant of POST /api/v2.1/triggerspostDelete a triggerdeleteGet a triggergetUpdate a triggerputThis is fake endpoint to describe variant of PUT /api/v2.1/triggers/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/triggers/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/triggers/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/triggers/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/triggers/{id}putThis is fake endpoint to describe variant of PUT /api/v2.1/triggers/{id}putWebhooks Event SubscriptionsConfiguring & testing WebhooksSubscriptionsGet all subscriptions for a projectgetCreate a subscriptionpostDelete a subscriptiondeleteADMIN ManagementAuthDisable user MFApostEnable user MFApostUser sign in with MFA.postVerifies MFA after enabling.postUser token refresh.postRegister new accountRegister new accountpostCompanies Management - for super adminGet all companiesgetUpdate company detailsputCreate a companypostGet a companygetUpdate a companyputProjects Management - for super adminGet all projectsgetUpdate project settingsputCreate a projectpostGet a projectgetUpdate a projectputQueue-TasksGet all queue tasksgetGet a queue task by task idgetCompanyProjectUsersGet all usersgetGet information about current user and projectgetGet all users within a projectgetCreate an user. Invite user.postResend invitation to new user (user who had never sign in)postGet a user by id, previously used email is deprecatedgetUpdate a userputDeactivate/Re-activate userputUIHealth checkgetUser sign inpostReset Api KeyputPassword reset - request reset tokenpostPassword reset - set new passwordputPassword reset - request reset tokenpostPassword reset - set new passwordputUser sign inpostPowered by Add customer to segmentput https://admin.sandbox.vouchery.app/api/v2.1/customers/{identifier}/categories/{category_name}/tags/{tag_name}Add customer to segment