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
Redemptions

Customer MANAGEMENT

Customers

Vouchery

Excluded Products
Campaigns
Categories
Rewards
Rules
Vouchers
Integrations
- Get list of project integrationsget
- Set MEWS integrationput
MEWS
- MEWS webhookpost

LOYALTY PROGRAM API

Loyalty Program

Automation API

Workflows
Triggers and events

Referral Program

Referral Program API

Webhooks Event Subscriptions

Configuring & testing Webhooks
Subscriptions

ADMIN Management

Auth
Register new account
- Register new accountpost
Companies Management - for super admin
Projects Management - for super admin
Queue-Tasks
- Get all queue tasksget
- Get a queue task by task idget
Company
Project
Users
UI

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
Redemptions

Customer MANAGEMENT

Customers

Vouchery

Excluded Products
Campaigns
Categories
Rewards
Rules
Vouchers
Integrations
- Get list of project integrationsget
- Set MEWS integrationput
MEWS
- MEWS webhookpost

LOYALTY PROGRAM API

Loyalty Program

Automation API

Workflows
Triggers and events

Referral Program

Referral Program API

Webhooks Event Subscriptions

Configuring & testing Webhooks
Subscriptions

ADMIN Management

Auth
Register new account
- Register new accountpost
Companies Management - for super admin
Projects Management - for super admin
Queue-Tasks
- Get all queue tasksget
- Get a queue task by task idget
Company
Project
Users
UI

This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rules

post https://admin.sandbox.vouchery.app/api/v2.1/campaigns/{campaign_id}/rules#___customer_category

Create a rule.

URL Expired

The URL for this request expired after 30 days.

Path Params

campaign_id

integer

required

Campaign ID

Body Params

Object to create

tags

array of strings

required

tags*

type

string

required

Responses

Response body

object

campaign_id

int64

Nullable. Integer or null

created_at

date-time

required

data

object of int32s

required

Rule configuration in JSON

Has additional fields

int64

required

rule_type

string

required

updated_at

date-time

required

Response body

object

code

string

required

error

boolean

required

message

string

required

type

string

required

Response body

object

code

string

required

error

boolean

required

message

string

required

type

string

required

Response body

object

code

string

required

error

boolean

required

errors

array of objects

required

errors*

object

attribute

string

required

Name of the property which is invalid

code

string

required

message

string

required

message

string

required

type

string

required

Response body

object

code

string

required

error

boolean

required

message

string

required

type

string

required

Updated over 1 year ago

This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rules

Did this page help you?

Language

Credentials

Header


xxxxxxxxxx
11
1
curl --request POST \
2
     --url 'https://admin.sandbox.vouchery.app/api/v2.1/campaigns/campaign_id/rules#___customer_category' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "category_type": "customer",
8
  "matching_type": "any_of",
9
  "type": "CustomerCategory"
10
}
11
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 1 year ago

This is fake endpoint to describe variant of POST /api/v2.1/campaigns/{campaign_id}/rules

Did this page help you?

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

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

Vouchery
Excluded Products
Update a excluded productput
Delete a excluded productdelete
Create a excluded productpost
Get all excluded productsget
Campaigns
Get a main campaignget
Get main campaigns with children by paramsget
Get a campaign's vouchers QR codesget
Get total campaign statsget
Get total campaign statsget
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
Update a campaignput
Get a campaignget
Get stats for single campaignget
Delete a campaigndelete
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
Get sub campaigns by paramsget
Get stats for all campaignsget
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
Create a campaignpost
Get all campaignsget
Categories
Update a categoryput
Get a categoryget
Delete a categorydelete
Create a categorypost
Get all categoriesget
Rewards
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
Create a trigger rewardpost
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
Update a rewardput
Get a rewardget
Delete a rewarddelete
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
Create a campaign rewardpost
Get all rewards for a campaignget
Rules
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
Update a ruleput
Get a ruleget
Delete a ruledelete
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
Create a rulepost
Get all rules for a campaignget
Vouchers
Validate voucherput
Unhide a voucherput
Mark voucher as distributedput
Hide a voucherput
Get voucher by code in extended versionget
Expire a voucherput
Get voucher by codeget
Delete a voucherdelete
Find a voucher by campaign metadataget
Import your own voucherspost
Export vouchersget
Expire a list of voucherspost
Distribute vouchers for a campaignget
Batch create vouchers for customers CSV filepost
Batch create vouchers for all customers in given categoriespost
Batch create voucherspost
Create a voucherpost
Get all vouchers for a campaignget
Generate voucher code for campaignpost
Integrations
Set MEWS integrationput
Get list of project integrationsget
MEWS
MEWS webhookpost

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

Automation API
Workflows
Deactivate a workflowpost
Activate a workflowpost
Update a workflowpatch
Get a workflowget
Delete a workflowdelete
Create a workflowpost
List workflowsget
Available eventsget
Triggers and events
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
Update a triggerput
Get a triggerget
Delete a triggerdelete
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
Create a triggerpost
Send custom eventpost
Get all triggers for the projectget
Invoke custom trigger - run eventpost

Referral Program
Referral Program API

Webhooks Event Subscriptions
Configuring & testing Webhooks
Subscriptions
Delete a subscriptiondelete
Create a subscriptionpost
Get all subscriptions for a projectget

ADMIN Management
Auth
User token refresh.post
Verifies MFA after enabling.post
User sign in with MFA.post
Enable user MFApost
Disable user MFApost
Register new account
Register new accountpost
Companies Management - for super admin
Update a companyput
Get a companyget
Create a companypost
Update company detailsput
Get all companiesget
Projects Management - for super admin
Update a projectput
Get a projectget
Create a projectpost
Update project settingsput
Get all projectsget
Queue-Tasks
Get a queue task by task idget
Get all queue tasksget
Company
Project
Users
Deactivate/Re-activate userput
Update a userput
Get a user by id, previously used email is deprecatedget
Resend invitation to new user (user who had never sign in)post
Create an user. Invite user.post
Get all users within a projectget
Get information about current user and projectget
Get all usersget
UI
User sign inpost
Password reset - set new passwordput
Password reset - request reset tokenpost
Password reset - set new passwordput
Password reset - request reset tokenpost
Reset Api Keyput
User sign inpost
Health checkget

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

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

Vouchery
Excluded Products
Update a excluded productput
Delete a excluded productdelete
Create a excluded productpost
Get all excluded productsget
Campaigns
Get a main campaignget
Get main campaigns with children by paramsget
Get a campaign's vouchers QR codesget
Get total campaign statsget
Get total campaign statsget
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
Update a campaignput
Get a campaignget
Get stats for single campaignget
Delete a campaigndelete
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
Get sub campaigns by paramsget
Get stats for all campaignsget
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
Create a campaignpost
Get all campaignsget
Categories
Update a categoryput
Get a categoryget
Delete a categorydelete
Create a categorypost
Get all categoriesget
Rewards
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
Create a trigger rewardpost
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
Update a rewardput
Get a rewardget
Delete a rewarddelete
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
Create a campaign rewardpost
Get all rewards for a campaignget
Rules
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
Update a ruleput
Get a ruleget
Delete a ruledelete
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
Create a rulepost
Get all rules for a campaignget
Vouchers
Validate voucherput
Unhide a voucherput
Mark voucher as distributedput
Hide a voucherput
Get voucher by code in extended versionget
Expire a voucherput
Get voucher by codeget
Delete a voucherdelete
Find a voucher by campaign metadataget
Import your own voucherspost
Export vouchersget
Expire a list of voucherspost
Distribute vouchers for a campaignget
Batch create vouchers for customers CSV filepost
Batch create vouchers for all customers in given categoriespost
Batch create voucherspost
Create a voucherpost
Get all vouchers for a campaignget
Generate voucher code for campaignpost
Integrations
Set MEWS integrationput
Get list of project integrationsget
MEWS
MEWS webhookpost

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

Automation API
Workflows
Deactivate a workflowpost
Activate a workflowpost
Update a workflowpatch
Get a workflowget
Delete a workflowdelete
Create a workflowpost
List workflowsget
Available eventsget
Triggers and events
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
Update a triggerput
Get a triggerget
Delete a triggerdelete
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
Create a triggerpost
Send custom eventpost
Get all triggers for the projectget
Invoke custom trigger - run eventpost

Referral Program
Referral Program API

Webhooks Event Subscriptions
Configuring & testing Webhooks
Subscriptions
Delete a subscriptiondelete
Create a subscriptionpost
Get all subscriptions for a projectget

ADMIN Management
Auth
User token refresh.post
Verifies MFA after enabling.post
User sign in with MFA.post
Enable user MFApost
Disable user MFApost
Register new account
Register new accountpost
Companies Management - for super admin
Update a companyput
Get a companyget
Create a companypost
Update company detailsput
Get all companiesget
Projects Management - for super admin
Update a projectput
Get a projectget
Create a projectpost
Update project settingsput
Get all projectsget
Queue-Tasks
Get a queue task by task idget
Get all queue tasksget
Company
Project
Users
Deactivate/Re-activate userput
Update a userput
Get a user by id, previously used email is deprecatedget
Resend invitation to new user (user who had never sign in)post
Create an user. Invite user.post
Get all users within a projectget
Get information about current user and projectget
Get all usersget
UI
User sign inpost
Password reset - set new passwordput
Password reset - request reset tokenpost
Password reset - set new passwordput
Password reset - request reset tokenpost
Reset Api Keyput
User sign inpost
Health checkget

200Created object

401Unauthorized error.

403Forbidden error.

422Unprocessable entity error. Validation failed.

500Internal server error. Try again in a few minutes or contact support.