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

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
projectId
string
required
actionParams
object
required
participantLimit
number
required
endTime
string
required
networkId
string
deprecated

DEPRECATED -- use chainId instead

chainId
number | null

used to specify the chain when a task supports multiple

actionId
string
taskId
string
rewardTokenId
string
deprecated

DEPRECATED -- use rewardTokenAddress and rewardTokenChainId instead

rewardTokenAddress
string
rewardTokenChainId
number
rewardTokenNetworkId
string
deprecated

DEPRECATED -- use rewardTokenChainId instead

rewardAmount
string | null

accepts integers or strings

startTime
string
accessList
object
allowAddresses
string[]
denyAddresses
string[]
budgetAddress
string

Response

200
application/json
Success
project
object
required
boost
object
required
reward
object
required