Membership Tier
This endpoint retrieves all the membershipTiers of an entity.
The Id of the user performing the request.
dummy-userid
The page number of expected set of documents.
1
The limit of the number of documents each page.
10
The API key for authentication
test
The secret key for authentication
test-secret
The token for user authentication.
dummy-token
GET /api/entities/{entityId}/membershipTiers HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Accept: */*
{
"success": true,
"data": [
{
"entityId": "entity123",
"membershipTier": 1,
"xpThreshold": 1000,
"isEnabled": true,
"createdAt": "2023-06-27T12:45:00Z",
"description": "Membership tier description",
"imageIPFS": "ipfs://image123"
}
]
}
This endpoint allows to add a new membershipTier for an entity.
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The secret key for authentication
test-secret
The token for user authentication.
dummy-token
100
2
ipfs-hash
description
POST /api/entities/{entityId}/membershipTiers HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 90
{
"xPThreshold": 100,
"membershipTier": 2,
"imageIPFS": "ipfs-hash",
"description": "description"
}
{
"success": true
}
This endpoint retrieves the membershipTier details of an entity.
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The secret key for authentication
test-secret
The token for user authentication.
dummy-token
GET /api/entities/{entityId}/membershipTiers/{membershipTier} HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Accept: */*
{
"success": true,
"data": {
"entityId": "entity123",
"membershipTier": 1,
"xpThreshold": 1000,
"isEnabled": true,
"createdAt": "2023-06-27T12:45:00Z",
"description": "Membership tier description",
"imageIPFS": "ipfs://image123"
}
}
This endpoint allows to update a membershipTier for an entity.
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The secret key for authentication
test-secret
The token for user authentication.
dummy-token
100
ipfs-hash
description
POST /api/entities/{entityId}/membershipTiers/{membershipTier}/update HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 71
{
"xPThreshold": 100,
"imageIPFS": "ipfs-hash",
"description": "description"
}
{
"success": true
}
This endpoint allows to delete a membershipTier for an entity.
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The secret key for authentication
test-secret
The token for user authentication.
dummy-token
POST /api/entities/{entityId}/membershipTiers/{membershipTier}/delete HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 2
{}
{
"success": true
}
This endpoint allows users to claim rewards for a specific membership tier of an entity.
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The secret key for authentication
test-secret
The token for user authentication.
dummy-token
POST /api/entities/{entityId}/membershipTiers/{membershipTier}/claim-rewards HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"addToDynamicNFT": true
}
{
"success": true
}
Last updated