Benefits

Here is where all the Benefits are gonna be managed

Create an Benefit

post

Authorizations

JWT

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequired

Name of the benefit

discountPercentagenumber · min: 100 · max: 10000Optional

Discount percentage multiplied by 100. Therefore, to create a benefit that gives a 10% discount, an input of 1000 is required for this property

givesWhitelistAccessbooleanRequired

If this benefit gives whitelist access

maxUsageLimitnumberRequired

The max amount of times this benefit can be used by a user

Responses

201Success

post

/api/v1/benefit

HTTPcURLJavaScriptPython

POST /api/v1/benefit HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "name": "text",
  "discountPercentage": 1,
  "givesWhitelistAccess": true,
  "maxUsageLimit": 1
}

201Success

No content

Get detailed Benefit info

get

Authorizations

JWT

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200Success

No content

get

/api/v1/benefit/{id}/manage

HTTPcURLJavaScriptPython

GET /api/v1/benefit/{id}/manage HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

No content

List Benefits

get

Authorizations

JWT

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

takenumberOptionalDefault: 36

skipnumberOptionalDefault: 0

Responses

200Success

No content

get

/api/v1/benefit/manage

HTTPcURLJavaScriptPython

GET /api/v1/benefit/manage HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

No content

Check if a user has access to your Benefits

post

Authorizations

JWT

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

userWalletsstring[]Required

Array of wallets that are gonna be checked to see if they have access to a benefit

Responses

201Success

application/json

post

/api/v1/benefit/check/manage

HTTPcURLJavaScriptPython

POST /api/v1/benefit/check/manage HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "userWallets": [
    "text"
  ]
}

201Success

{}

Update an Benefit

patch

Authorizations

JWT

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

application/json

namestringOptional

Name of the benefit

discountPercentagenumberOptional

Discount percentage multiplied by 100. Therefore, to create a benefit that gives a 10% discount, an input of 1000 is required for this property

givesWhitelistAccessbooleanRequired

If this benefit gives whitelist access

Responses

200Success

No content

patch

/api/v1/benefit/{id}

HTTPcURLJavaScriptPython

PATCH /api/v1/benefit/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "name": "text",
  "discountPercentage": 1,
  "givesWhitelistAccess": true
}

200Success

No content

Remove an Benefit

delete

Authorizations

JWT

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200Success

No content

delete

/api/v1/benefit/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/benefit/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

No content