Sign in Try for Free

Menu

Voucherify actions

Pick an action to see its parameters, request body and response fields.

246 actions

Async Actions · 2

GETGet Async Action/v1/async-actions/{asyncActionId}Get Async Action GETList Async Actions/v1/async-actionsList Async Actions

Bin · 2

DELETEDelete Bin Entry/v1/trash-bin/{binEntryId}Delete Bin Entry GETList Bin Entries/v1/trash-binList Bin Entries

Campaigns · 14

POSTAdd Voucher With Specific Code To Campaign/v1/campaigns/{campaignId}/vouchers/{code}Add Voucher with Specific Code to Campaign POSTAdd Vouchers To Campaign/v1/campaigns/{campaignId}/vouchersAdd Vouchers to Campaign POSTCreate Campaign/v1/campaignsCreate Campaign DELETEDelete Campaign/v1/campaigns/{campaignId}Delete Campaign POSTDisable Campaign/v1/campaigns/{campaignId}/disableDisable Campaign POSTEnable Campaign/v1/campaigns/{campaignId}/enableEnable Campaign POSTExport Campaign Transactions/v1/campaigns/{campaignId}/transactions/exportExport Campaign Transactions GETGet Campaign/v1/campaigns/{campaignId}Get Campaign GETGet Campaign Summary/v1/campaigns/{campaignId}/summaryGet Campaign Summary POSTImport Vouchers To Campaign/v1/campaigns/{campaignId}/importImport Vouchers to Campaign POSTImport Vouchers To Campaign Using Csv/v1/campaigns/{campaignId}/importCSVImport Vouchers to Campaign by CSV GETList Campaign Transactions/v1/campaigns/{campaignId}/transactionsList Campaign Transactions GETList Campaigns/v1/campaignsList Campaigns PUTUpdate Campaign/v1/campaigns/{campaignId}Update Campaign

Categories · 5

POSTCreate Category/v1/categoriesCreate Category DELETEDelete Category/v1/categories/{categoryId}Delete Category GETGet Category/v1/categories/{categoryId}Get Category GETList Categories/v1/categoriesList Categories PUTUpdate Category/v1/categories/{categoryId}Update Category

Client-side · 5

POSTCheck Eligibility Client Side/client/v1/qualificationsCheck Eligibility (client-side)GETList Promotion Tiers Client Side/client/v1/promotions/tiersList Promotion Tiers (client-side)POSTRedeem Stacked Discounts Client Side/client/v1/redemptionsRedeem Stackable Discounts (client-side)POSTTrack Custom Event Client Side/client/v1/eventsTrack Custom Event (client-side)POSTValidate Stacked Discounts Client Side/client/v1/validationsValidate Stackable Discounts (client-side)

Customers · 12

POSTCreate Customer/v1/customersCreate Customer POSTCustomer Permanently Deletion/v1/customers/{customerId}/permanent-deletionDelete Customer Permanently DELETEDelete Customer/v1/customers/{customerId}Delete Customer GETGet Customer/v1/customers/{customerId}Get Customer POSTImport Customers Using Csv/v1/customers/importCSVImport and Update Customers using CSV GETList Customer Activity/v1/customers/{customerId}/activityList Customer Activity GETList Customer Redeemables/v1/customers/{customerId}/redeemablesList Customer's Redeemables GETList Customer Segments/v1/customers/{customerId}/segmentsList Customer's Segments GETList Customers/v1/customersList Customers PUTUpdate Customer/v1/customers/{customerId}Update Customer POSTUpdate Customers In Bulk/v1/customers/bulk/asyncUpdate Customers in Bulk POSTUpdate Customers Metadata In Bulk/v1/customers/metadata/asyncUpdate Customers' Metadata in Bulk

Events · 1

POSTTrack Custom Event/v1/eventsTrack Custom Event

Exports · 5

POSTCreate Export/v1/exportsCreate Export DELETEDelete Export/v1/exports/{exportId}Delete Export GETDownload Export/v1/exports/{export_Id}Download Export GETGet Export/v1/exports/{exportId}Get Export GETList Exports/v1/exportsList Exports

Generic Request · 5

DELETEGeneric Delete Request/{path}Generic DELETE Request GETGeneric Get Request/{path}Generic GET Request PATCHGeneric Patch Request/{path}Generic PATCH Request POSTGeneric Post Request/{path}Generic POST Request PUTGeneric Put Request/{path}Generic PUT Request

Locations · 2

GETGet Location/v1/locations/{locationId}Get Location GETList Locations/v1/locationsList Locations

Loyalties · 52

POSTActivate Member Pending Points/v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/activateActivate Member Pending Points POSTAdd Member/v1/loyalties/{campaignId}/membersAdd Member POSTAdjust Member Pending Points/v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balanceAdjust Member Pending Points POSTCancel Member Pending Points/v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/cancelCancel Member Pending Points POSTCreate Earning Rule/v1/loyalties/{campaignId}/earning-rulesCreate Earning Rule POSTCreate In Bulk Loyalty Tiers/v1/loyalties/{campaignId}/tiersCreate loyalty tiers POSTCreate Loyalty Program/v1/loyaltiesCreate Loyalty Campaign POSTCreate Points Expiration Export/v1/loyalties/{campaignId}/points-expiration/exportExport Loyalty Campaign Point Expiration POSTCreate Reward Assignment 1/v1/loyalties/{campaignId}/rewardsCreate Loyalty Campaign Reward Assignment DELETEDelete Earning Rule/v1/loyalties/{campaignId}/earning-rules/{earningRuleId}Delete Earning Rule DELETEDelete Loyalty Program/v1/loyalties/{campaignId}Delete Loyalty Campaign DELETEDelete Reward Assignment 1/v1/loyalties/{campaignId}/rewards/{assignmentId}Delete Campaign Reward Assignment POSTDisable Earning Rule/v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disableDisable Earning Rule POSTEnable Earning Rule/v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enableEnable Earning Rule POSTExport Loyalty Campaign Transactions/v1/loyalties/{campaignId}/transactions/exportExport Loyalty Campaign Transactions POSTExport Loyalty Card Transactions/v1/loyalties/members/{memberId}/transactions/exportExport Loyalty Card Transactions POSTExport Loyalty Card Transactions 1/v1/loyalties/{campaignId}/members/{memberId}/transactions/exportExport Loyalty Card Transactions with campaign ID GETGet Earning Rule/v1/loyalties/{campaignId}/earning-rules/{earningRuleId}Get Earning Rule GETGet Loyalty Program/v1/loyalties/{campaignId}Get Loyalty Campaign GETGet Loyalty Tier/v1/loyalties/{campaignId}/tiers/{loyaltyTierId}Get Loyalty Tier GETGet Member/v1/loyalties/members/{memberId}Get Member GETGet Member 1/v1/loyalties/{campaignId}/members/{memberId}Get Member with campaign ID GETGet Reward Assignment 1/v1/loyalties/{campaignId}/reward-assignments/{assignmentId}Get Campaign Reward Assignments GETGet Reward Assignment 2/v1/loyalties/{campaignId}/rewards/{assignmentId}Get Campaign Reward Assignment GETGet Reward Details/v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/rewardGet Reward Details GETList Campaign Pending Points/v1/loyalties/{campaignId}/pending-pointsList Campaign Pending Points GETList Earning Rules/v1/loyalties/{campaignId}/earning-rulesList Earning Rules GETList Loyalty Campaign Transactions/v1/loyalties/{campaignId}/transactionsList Loyalty Campaign Transactions GETList Loyalty Card Transactions/v1/loyalties/members/{memberId}/transactionsList Loyalty Card Transactions GETList Loyalty Card Transactions 1/v1/loyalties/{campaignId}/members/{memberId}/transactionsList Loyalty Card Transactions with campaign ID GETList Loyalty Programs/v1/loyaltiesList Loyalty Campaigns GETList Loyalty Tier Earning Rules/v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rulesList Loyalty Tier Earning Rules GETList Loyalty Tier Rewards/v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewardsList Loyalty Tier Rewards GETList Loyalty Tiers/v1/loyalties/{campaignId}/tiersList Loyalty Tiers GETList Member Activity/v1/loyalties/members/{memberId}/activityList Member Activity GETList Member Activity 1/v1/loyalties/{campaignId}/members/{memberId}/activityList Member Activity with campaign ID GETList Member Loyalty Tier/v1/loyalties/members/{memberId}/tiersList Member's Loyalty Tiers GETList Member Pending Points/v1/loyalties/members/{memberId}/pending-pointsList Member Pending Points GETList Member Pending Points 1/v1/loyalties/{campaignId}/members/{memberId}/pending-pointsList Member Pending Points with campaign ID GETList Member Rewards/v1/loyalties/members/{memberId}/rewardsList Member Rewards GETList Members/v1/loyalties/{campaignId}/membersList Members GETList Points Expiration/v1/loyalties/{campaignId}/members/{memberId}/points-expirationList Loyalty Card Point Expiration GETList Reward Assignments 1/v1/loyalties/{campaignId}/reward-assignmentsList Reward Assignments with campaign ID GETList Reward Assignments 2/v1/loyalties/{campaignId}/rewardsList Campaign Rewards POSTRedeem Reward/v1/loyalties/members/{memberId}/redemptionRedeem Reward POSTRedeem Reward 1/v1/loyalties/{campaignId}/members/{memberId}/redemptionRedeem Reward with campaign ID POSTTransfer Points/v1/loyalties/{campaignId}/members/{memberId}/transfersTransfer Loyalty Points PUTUpdate Earning Rule/v1/loyalties/{campaignId}/earning-rules/{earningRuleId}Update Earning Rule POSTUpdate Loyalty Card Balance/v1/loyalties/members/{memberId}/balanceAdjust Loyalty Card Balance POSTUpdate Loyalty Card Balance 1/v1/loyalties/{campaignId}/members/{memberId}/balanceAdjust Loyalty Card Balance with campaign ID PUTUpdate Loyalty Program/v1/loyalties/{campaignId}Update Loyalty Campaign PUTUpdate Reward Assignment 1/v1/loyalties/{campaignId}/rewards/{assignmentId}Update Campaign Reward Assignment

Management · 38

POSTAssign User/management/v1/projects/{projectId}/usersAssign User POSTCreate Brand/management/v1/projects/{projectId}/brandingCreate Brand POSTCreate Custom Event Schema/management/v1/projects/{projectId}/custom-event-schemasCreate Custom Event Schema POSTCreate Metadata Schema/management/v1/projects/{projectId}/metadata-schemasCreate Metadata Schema POSTCreate Project/management/v1/projectsCreate Project POSTCreate Stacking Rules/management/v1/projects/{projectId}/stacking-rulesCreate Stacking Rules POSTCreate Webhook/management/v1/projects/{projectId}/webhooksCreate Webhook DELETEDelete Brand/management/v1/projects/{projectId}/branding/{brandingId}Delete Brand DELETEDelete Custom Event Schema/management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId}Delete Custom Event Schema DELETEDelete Metadata Schema/management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId}Delete Metadata Schema DELETEDelete Project/management/v1/projects/{projectId}Delete Project DELETEDelete Stacking Rules/management/v1/projects/{projectId}/stacking-rules/{stackingRulesId}Delete Stacking Rules DELETEDelete Webhook/management/v1/projects/{projectId}/webhooks/{webhookId}Delete Webhook GETGet Brand/management/v1/projects/{projectId}/branding/{brandingId}Get Brand GETGet Custom Event Schema/management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId}Get Custom Event Schema GETGet Metadata Schema 1/management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId}Get Metadata Schema GETGet Project/management/v1/projects/{projectId}Get Project GETGet Stacking Rules/management/v1/projects/{projectId}/stacking-rules/{stackingRulesId}Get Stacking Rules GETGet User/management/v1/projects/{projectId}/users/{userId}Get User GETGet Webhook/management/v1/projects/{projectId}/webhooks/{webhookId}Get Webhook POSTInvite User/management/v1/projects/users/inviteInvite a New User GETList Brands/management/v1/projects/{projectId}/brandingList Brands GETList Custom Event Schemas/management/v1/projects/{projectId}/custom-event-schemasList Custom Event Schemas GETList Metadata Schemas 1/management/v1/projects/{projectId}/metadata-schemasList Metadata Schemas GETList Projects/management/v1/projectsList Projects GETList Stacking Rules/management/v1/projects/{projectId}/stacking-rulesList Stacking Rules GETList Users/management/v1/projects/{projectId}/usersList Users GETList Webhooks/management/v1/projects/{projectId}/webhooksList Webhooks POSTManagement Copy Campaign Template/management/v1/projects/{projectId}/templates/campaigns/{campaignTemplateId}/copyCopy Campaign Template to a Project GETManagement List Campaign Templates/management/v1/projects/{projectId}/templates/campaignsList Campaign Templates DELETEUnassign User/management/v1/projects/{projectId}/users/{userId}Unassign User PUTUpdate Brand/management/v1/projects/{projectId}/branding/{brandingId}Update Brand PUTUpdate Custom Event Schema/management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId}Update Custom Event Schema PUTUpdate Metadata Schema/management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId}Update Metadata Schema PUTUpdate Project/management/v1/projects/{projectId}Update Project PUTUpdate Stacking Rules/management/v1/projects/{projectId}/stacking-rules/{stackingRulesId}Update Stacking Rules PUTUpdate User/management/v1/projects/{projectId}/users/{userId}Update User PUTUpdate Webhook/management/v1/projects/{projectId}/webhooks/{webhookId}Update Webhook

Metadata Schemas · 2

GETGet Metadata Schema/v1/metadata-schemas/{resource}Get Metadata Schema GETList Metadata Schemas/v1/metadata-schemasList Metadata Schema Definitions

Orders · 6

POSTCreate Order/v1/ordersCreate Order POSTCreate Order Export/v1/orders/exportCreate Orders Export GETGet Order/v1/orders/{orderId}Get Order POSTImport Orders/v1/orders/importImport Orders GETList Orders/v1/ordersList Orders PUTUpdate Order/v1/orders/{orderId}Update Order

Product Collections · 5

POSTCreate Product Collection/v1/product-collectionsCreate Product Collection DELETEDelete Product Collection/v1/product-collections/{productCollectionId}Delete Product Collection GETGet Product Collection/v1/product-collections/{productCollectionId}Get Product Collection GETList Product Collections/v1/product-collectionsList Product Collections GETList Products In Collection/v1/product-collections/{productCollectionId}/productsList Products in Collection

Products · 14

POSTCreate Product/v1/productsCreate Product POSTCreate Sku/v1/products/{productId}/skusCreate SKU DELETEDelete Product/v1/products/{productId}Delete Product DELETEDelete Sku/v1/products/{productId}/skus/{skuId}Delete SKU GETGet Product/v1/products/{productId}Get Product GETGet Sku/v1/skus/{skuId}Get SKU POSTImport Products Using Csv/v1/products/importCSVImport Products using CSV POSTImport SK Us Using Csv/v1/skus/importCSVImport SKUs using CSV GETList Products/v1/productsList Products GETList SK Us In Product/v1/products/{productId}/skusList SKUs in Product PUTUpdate Product/v1/products/{productId}Update Product POSTUpdate Products In Bulk/v1/products/bulk/asyncUpdate Products in Bulk POSTUpdate Products Metadata In Bulk/v1/products/metadata/asyncUpdate Products' Metadata in Bulk PUTUpdate Sku/v1/products/{productId}/skus/{skuId}Update SKU

Promotions · 14

POSTAdd Promotion Tier To Campaign/v1/promotions/{campaignId}/tiersAdd Promotion Tier to Campaign POSTCreate Promotion Stack/v1/promotions/{campaignId}/stacksCreate Promotion Stack DELETEDelete Promotion Stack/v1/promotions/{campaignId}/stacks/{stackId}Delete Promotion Stack DELETEDelete Promotion Tier/v1/promotions/tiers/{promotionTierId}Delete Promotion Tier POSTDisable Promotion Tier/v1/promotions/tiers/{promotionTierId}/disableDisable Promotion Tier POSTEnable Promotion Tier/v1/promotions/tiers/{promotionTierId}/enableEnable Promotion Tier GETGet Promotion Stack/v1/promotions/{campaignId}/stacks/{stackId}Get Promotion Stack GETGet Promotion Tier/v1/promotions/tiers/{promotionTierId}Get Promotion Tier GETList All Promotion Stacks/v1/promotions/stacksList Promotion Stacks GETList Promotion Stacks In Campaign/v1/promotions/{campaignId}/stacksList Promotion Stacks in Campaign GETList Promotion Tiers/v1/promotions/tiersList Promotion Tiers GETList Promotion Tiers From Campaign/v1/promotions/{campaignId}/tiersList Promotion Tiers from Campaign PUTUpdate Promotion Stack/v1/promotions/{campaignId}/stacks/{stackId}Update Promotion Stack PUTUpdate Promotion Tier/v1/promotions/tiers/{promotionTierId}Update Promotion Tier

Publications · 3

POSTCreate Publication/v1/publicationsCreate Publication GETCreate Publication 1/v1/publications/createCreate Publication with GET GETList Publications/v1/publicationsList Publications

Qualifications · 1

POSTCheck Eligibility/v1/qualificationsCheck Eligibility

Redemptions · 6

GETGet Redemption/v1/redemptions/{redemptionId}Get Redemption GETGet Voucher Redemptions/v1/vouchers/{code}/redemptionGet Voucher's Redemptions GETList Redemptions/v1/redemptionsList Redemptions POSTRedeem Stacked Discounts/v1/redemptionsRedeem Stackable Discounts POSTRollback Redemption/v1/redemptions/{redemptionId}/rollbackRollback Redemption POSTRollback Stacked Redemptions/v1/redemptions/{parentRedemptionId}/rollbacksRollback Stackable Redemptions

Referrals · 6

POSTReferrals Add Holders/v1/referrals/members/{memberId}/holdersAdd Referral Code Holders POSTReferrals Add Holders 1/v1/referrals/{campaignId}/members/{memberId}/holdersAdd Referral Code Holders with Campaign ID GETReferrals Code Holders/v1/referrals/{campaignId}/members/{memberId}/holdersList Referral Code Holders with campaign ID GETReferrals Code Holders 1/v1/referrals/members/{memberId}/holdersList Referral Code Holders DELETEReferrals Remove Holder/v1/referrals/members/{memberId}/holders/{holderId}Remove Referral Card Holder DELETEReferrals Remove Holder 1/v1/referrals/{campaignId}/members/{memberId}/holders/{holderId}Remove Referral Card Holder with campaign ID

Rewards · 10

POSTCreate Reward/v1/rewardsCreate Reward POSTCreate Reward Assignment/v1/rewards/{rewardId}/assignmentsCreate Reward Assignment DELETEDelete Reward/v1/rewards/{rewardId}Delete Reward DELETEDelete Reward Assignment/v1/rewards/{rewardId}/assignments/{assignmentId}Delete Reward Assignment GETGet Reward/v1/rewards/{rewardId}Get Reward GETGet Reward Assignment/v1/rewards/{rewardId}/assignments/{assignmentId}Get Reward Assignment GETList Reward Assignments/v1/rewards/{rewardId}/assignmentsList Reward Assignments GETList Rewards/v1/rewardsList Rewards PUTUpdate Reward/v1/rewards/{rewardId}Update Reward PUTUpdate Reward Assignment/v1/rewards/{rewardId}/assignments/{assignmentId}Update Reward Assignment

Segments · 3

POSTCreate Segment/v1/segmentsCreate Segment DELETEDelete Segment/v1/segments/{segmentId}Delete Segment GETGet Segment/v1/segments/{segmentId}Get Segment

Templates · 7

POSTAdd Tier From Template/v1/templates/campaigns/{campaignTemplateId}/tier-setupAdd Promotion Tier From Template POSTCreate Campaign From Template/v1/templates/campaigns/{campaignTemplateId}/campaign-setupCreate Campaign From Template POSTCreate Campaign Template/v1/templates/campaignsCreate Campaign Template DELETEDelete Campaign Template/v1/templates/campaigns/{campaignTemplateId}Delete Campaign Template GETGet Campaign Template/v1/templates/campaigns/{campaignTemplateId}Get Campaign Template GETList Campaign Templates/v1/templates/campaignsList Campaign Templates PUTUpdate Campaign Template/v1/templates/campaigns/{campaignTemplateId}Update Campaign Template

Validation Rules · 9

POSTCreate Validation Rule Assignment/v1/validation-rules/{validationRuleId}/assignmentsCreate Validation Rules Assignments POSTCreate Validation Rules/v1/validation-rulesCreate Validation Rules DELETEDelete Validation Rule Assignment/v1/validation-rules/{validationRuleId}/assignments/{assignmentId}Delete Validation Rule Assignment DELETEDelete Validation Rules/v1/validation-rules/{validationRuleId}Delete Validation Rule GETGet Validation Rule/v1/validation-rules/{validationRuleId}Get Validation Rule GETList Validation Rule Assignments/v1/validation-rules/{validationRuleId}/assignmentsList Validation Rule Assignments GETList Validation Rules/v1/validation-rulesList Validation Rules GETList Validation Rules Assignments/v1/validation-rules-assignmentsList Validation Rules' Assignment(s)PUTUpdate Validation Rule/v1/validation-rules/{validationRuleId}Update Validation Rule

Validations · 1

POSTValidate Stacked Discounts/v1/validationsValidate Stackable Discounts

Vouchers · 16

POSTCreate Voucher/v1/vouchers/{code}Create Voucher DELETEDelete Voucher/v1/vouchers/{code}Delete Voucher POSTDisable Voucher/v1/vouchers/{code}/disableDisable Voucher POSTEnable Voucher/v1/vouchers/{code}/enableEnable Voucher POSTExport Voucher Transactions/v1/vouchers/{code}/transactions/exportExport Voucher Transactions POSTGenerate Random Code/v1/vouchersGenerate Random Code GETGet Voucher/v1/vouchers/{code}Get Voucher POSTImport Vouchers/v1/vouchers/importImport Vouchers POSTImport Vouchers Using Csv/v1/vouchers/importCSVImport Vouchers using CSV GETList Voucher Transactions/v1/vouchers/{code}/transactionsList Voucher Transactions GETList Vouchers/v1/vouchersList Vouchers DELETERelease Validation Session/v1/vouchers/{code}/sessions/{sessionKey}Release Validation Session PUTUpdate Voucher/v1/vouchers/{code}Update Voucher POSTUpdate Voucher Balance/v1/vouchers/{code}/balanceAdjust Voucher Balance POSTUpdate Vouchers In Bulk/v1/vouchers/bulk/asyncUpdate Vouchers in Bulk POSTUpdate Vouchers Metadata In Bulk/v1/vouchers/metadata/asyncUpdate Vouchers' Metadata in Bulk