boosts
create boost
manager
metrics
accesslists
boosts
users
- GETuser profile
- GETuser details
- PUTupdate profile
- GETETH earned by user
- PUTupdate notification preferences
- GETfarcaster profile
- GETfarcaster verification status
- POSTadd neynar connection
- DELremove neynar connection
- POSTadd twitter connection
- DELdelete twitter connection
- GETUser notifications
- POSTRead notifications
- GETuser rewards
- GETprotocol rewards summary
- GETprotocol rewards earnings
- GETreferrals summary
- GETreferrals earnings
- GETreferrals feed
- GETtotal referral earnings
- GETreferrals activity feed
- GETactive/completed boosts referrals feed
boosts
create boost
Create a new boost
POST
/
boosts
curl --request POST \
--url https://api-staging.boost.xyz/boosts/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"networkId": "<string>",
"chainId": 123,
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"taskId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actionParams": {
"type": "bridge",
"data": {
"destinationNetworkId": "<string>",
"sourceChainId": 123,
"destinationChainId": 123,
"tokenAddress": "<string>",
"tokenDecimals": 123,
"amount": "<string>",
"amountOperator": "any"
}
},
"rewardTokenId": "<string>",
"rewardTokenAddress": "<string>",
"rewardTokenChainId": 123,
"rewardTokenNetworkId": "<string>",
"rewardAmount": "<string>",
"participantLimit": 123,
"startTime": "<string>",
"endTime": "<string>",
"accessList": {
"allow": [
"<string>"
],
"deny": [
"<string>"
]
},
"allowAddresses": [
"<string>"
],
"denyAddresses": [
"<string>"
],
"budgetAddress": "<string>"
}'
{
"project": {
"id": "<string>",
"name": "<string>"
},
"boost": {
"id": "<string>",
"name": "<string>",
"appLink": "<string>",
"description": "<string>",
"boostStart": "<string>",
"boostEnd": "<string>",
"network": "<string>",
"iconOption": "<string>",
"imagePath": "<string>",
"createdAt": "<string>",
"status": "<string>",
"receiptsMinted": 123,
"creatorAddress": "<string>",
"contractAddress": "<string>",
"actionParams": {
"type": "bridge",
"data": {
"destinationNetworkId": "<string>",
"sourceChainId": 123,
"destinationChainId": 123,
"tokenAddress": "<string>",
"tokenDecimals": 123,
"amount": "<string>",
"amountOperator": "any"
}
}
},
"reward": {
"amount": "<string>",
"totalAllocated": 123,
"type": "<string>",
"tokenSymbol": "<string>",
"token": "<string>",
"network": "<string>",
"s3Link": "<string>",
"ethValue": "<string>",
"decimals": 123,
"tokenId": "<string>"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Available options:
bridge
Available options:
any
, gt
, gte
, lt
, lte
, eq
DEPRECATED -- use chainId instead
used to specify the chain when a task supports multiple
DEPRECATED -- use rewardTokenAddress and rewardTokenChainId instead
DEPRECATED -- use rewardTokenChainId instead
accepts integers or strings
Response
200
application/json
Success
Available options:
bridge
Available options:
any
, gt
, gte
, lt
, lte
, eq
curl --request POST \
--url https://api-staging.boost.xyz/boosts/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"networkId": "<string>",
"chainId": 123,
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"taskId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actionParams": {
"type": "bridge",
"data": {
"destinationNetworkId": "<string>",
"sourceChainId": 123,
"destinationChainId": 123,
"tokenAddress": "<string>",
"tokenDecimals": 123,
"amount": "<string>",
"amountOperator": "any"
}
},
"rewardTokenId": "<string>",
"rewardTokenAddress": "<string>",
"rewardTokenChainId": 123,
"rewardTokenNetworkId": "<string>",
"rewardAmount": "<string>",
"participantLimit": 123,
"startTime": "<string>",
"endTime": "<string>",
"accessList": {
"allow": [
"<string>"
],
"deny": [
"<string>"
]
},
"allowAddresses": [
"<string>"
],
"denyAddresses": [
"<string>"
],
"budgetAddress": "<string>"
}'
{
"project": {
"id": "<string>",
"name": "<string>"
},
"boost": {
"id": "<string>",
"name": "<string>",
"appLink": "<string>",
"description": "<string>",
"boostStart": "<string>",
"boostEnd": "<string>",
"network": "<string>",
"iconOption": "<string>",
"imagePath": "<string>",
"createdAt": "<string>",
"status": "<string>",
"receiptsMinted": 123,
"creatorAddress": "<string>",
"contractAddress": "<string>",
"actionParams": {
"type": "bridge",
"data": {
"destinationNetworkId": "<string>",
"sourceChainId": 123,
"destinationChainId": 123,
"tokenAddress": "<string>",
"tokenDecimals": 123,
"amount": "<string>",
"amountOperator": "any"
}
}
},
"reward": {
"amount": "<string>",
"totalAllocated": 123,
"type": "<string>",
"tokenSymbol": "<string>",
"token": "<string>",
"network": "<string>",
"s3Link": "<string>",
"ethValue": "<string>",
"decimals": 123,
"tokenId": "<string>"
}
}