Token Gating APIs
PUT Token Gate
- Documentation
- Introduction
- Overview
- Quickstart
- Errors
- Pagination
Wallet Creation APIs
Wallet Experience APIs
NFT APIs
- Overview
Minting APIs
Commerce APIs
Droplink APIs
Token Gating APIs
- Miscellaneous NFT APIs
Web3 APIs
SDK
Overview
Wallet as a Service (WaaS)
Token Gating APIs
PUT Token Gate
Limit access to web pages or other experiences to users who control a specific token.
PUT
/
v1
/
apps
/
{appId}
/
gates
/
{gateId}
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
appId
string
*
appId
Required
string
Your Bitski Application ID
gateId
string
*
gateId
Required
string
The ID of the token being gated
curl -X 'PUT' \
'https://api.bitski.com/v1/apps/<APP_ID>/gates/<GATE_ID>' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-d '{
"gate": {
"description": "In order to continue you must have a bird NFT in your wallet.",
"filters": [
{
"attributes": [
{
"key": "Level",
"value": "3"
}
],
"contractId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Bird contract",
"tokenIds": "0x1"
}
],
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"image": "https://cdn.bitskistatic.com/tokens-raw/54676382-bab5-408d-afe2-fc6f160da4a8/06fd0294-a425-44c7-96e8-9d24757163b4.png",
"isActive": true,
"isPublished": true,
"name": "Must hold a bird NFT to continue."
}
}'
{
"gate": {
"createdAt": "2023-04-21T00:52:48.459Z",
"description": "In order to continue you must have a bird NFT in your wallet.",
"filters": [
{
"attributes": [
{
"key": "Level",
"value": "3"
}
],
"contractId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdAt": "2023-04-21T00:52:48.459Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Bird contract",
"tokenIds": [
"0x1"
]
}
],
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"image": "https://cdn.bitskistatic.com/tokens-raw/54676382-bab5-408d-afe2-fc6f160da4a8/06fd0294-a425-44c7-96e8-9d24757163b4.png",
"isActive": true,
"isPublished": true,
"name": "Must hold a bird NFT to continue."
}
}
Access to this API is available upon request to sales@bitski.com.
Path
appId
string
requiredYour Bitski Application ID
gateId
string
requiredThe ID of the token being gated
Examples
Response
gate
Gate object
requiredid
string
requiredname
string
requiredimage
string
requireddescription
string
createdAt
string
requiredfilters
array
requiredisActive
boolean
requiredisPublished
boolean
requiredcurl -X 'PUT' \
'https://api.bitski.com/v1/apps/<APP_ID>/gates/<GATE_ID>' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-d '{
"gate": {
"description": "In order to continue you must have a bird NFT in your wallet.",
"filters": [
{
"attributes": [
{
"key": "Level",
"value": "3"
}
],
"contractId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Bird contract",
"tokenIds": "0x1"
}
],
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"image": "https://cdn.bitskistatic.com/tokens-raw/54676382-bab5-408d-afe2-fc6f160da4a8/06fd0294-a425-44c7-96e8-9d24757163b4.png",
"isActive": true,
"isPublished": true,
"name": "Must hold a bird NFT to continue."
}
}'
{
"gate": {
"createdAt": "2023-04-21T00:52:48.459Z",
"description": "In order to continue you must have a bird NFT in your wallet.",
"filters": [
{
"attributes": [
{
"key": "Level",
"value": "3"
}
],
"contractId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdAt": "2023-04-21T00:52:48.459Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Bird contract",
"tokenIds": [
"0x1"
]
}
],
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"image": "https://cdn.bitskistatic.com/tokens-raw/54676382-bab5-408d-afe2-fc6f160da4a8/06fd0294-a425-44c7-96e8-9d24757163b4.png",
"isActive": true,
"isPublished": true,
"name": "Must hold a bird NFT to continue."
}
}