Vouchers
get
Authorizations
Path parameters
companyIdstringRequired
Query parameters
pagenumberOptionalDefault:
1limitnumberOptionalDefault:
10searchstringOptional
sortBystringOptional
orderBystring · enumOptionalDefault:
DESCPossible values: enabledbooleanOptional
startDatestringOptionalExample:
2022-07-20T23:59:59.000ZendDatestringOptionalExample:
2022-07-20T23:59:59.000ZResponses
401
Need user with one of these roles: superAdmin, admin
get
GET /{companyId}/vouchers HTTP/1.1
Host:
x-w3block-api-key: YOUR_API_KEY
Accept: */*
401
Need user with one of these roles: superAdmin, admin
No content
post
Authorizations
Path parameters
companyIdstringRequired
Body
codestringOptional
amountnumberOptionalDefault:
1limitPerUsernumberOptionalDefault:
1userIdstringOptional
whitelistIdstringOptional
startDatestringOptionalExample:
2022-07-20T23:59:59.000ZendDatestringOptionalExample:
2022-07-20T23:59:59.000ZResponses
401
Need user with one of these roles: superAdmin, admin
post
POST /{companyId}/vouchers HTTP/1.1
Host:
x-w3block-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 261
{
"code": "text",
"amount": 1,
"limitPerUser": 1,
"userId": "text",
"whitelistId": "text",
"tokenCollections": [
{
"tokenCollectionId": "123e4567-e89b-12d3-a456-426614174000",
"tokenEditionIds": [
[]
]
}
],
"startDate": "2022-07-20T23:59:59.000Z",
"endDate": "2022-07-20T23:59:59.000Z"
}401
Need user with one of these roles: superAdmin, admin
No content
delete
Authorizations
Path parameters
idstringRequired
companyIdstringRequired
Responses
401
Need user with one of these roles: superAdmin, admin
delete
DELETE /{companyId}/vouchers/{id} HTTP/1.1
Host:
x-w3block-api-key: YOUR_API_KEY
Accept: */*
401
Need user with one of these roles: superAdmin, admin
No content
get
Authorizations
Path parameters
companyIdstringRequired
codestringRequired
Responses
200Success
401
Unauthorized - Integration API key or JWT required
get
GET /{companyId}/vouchers/{code} HTTP/1.1
Host:
x-w3block-api-key: YOUR_API_KEY
Accept: */*
No content
post
Authorizations
Path parameters
companyIdstringRequired
Body
codestringRequired
userIdstringRequired
Responses
201Success
401
Unauthorized - Integration API key or JWT required
post
POST /{companyId}/vouchers/redeem HTTP/1.1
Host:
x-w3block-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31
{
"code": "text",
"userId": "text"
}No content
Last updated