Skip to main content
POST
/
v1
/
community
/
tipping
/
airdrops
cURL
curl --request POST \
  --url https://api.flipsuite.xyz/v1/community/tipping/airdrops \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "channelId": "1234567890123456789",
  "item": {
    "type": "TOKEN",
    "chain": "Polygon",
    "tokenAddress": "0x162539172b53e9a93b7d98fb6c41682de558a320",
    "amount": 1000
  },
  "countdown": 60000,
  "maxEntries": 10,
  "comment": "Hello, world!",
  "allowedRoleIds": [
    "12345678901234567891",
    "12345678901234567892"
  ],
  "allowedUserIds": [
    "12345678901234567893",
    "12345678901234567894"
  ],
  "forbiddenRoleIds": [
    "12345678901234567895",
    "12345678901234567896"
  ],
  "forbiddenUserIds": [
    "12345678901234567897",
    "12345678901234567898"
  ]
}
'

Headers

​
x-api-key
string<uuid>
required

Your community API key.

Body

application/json
​
channelId
string

ID of a Discord channel in your server where the airdrop should be created.

​
item
Token · object
​
countdown
integer

Number of milliseconds before the airdrop ends and the prize is distributed. Cannot be longer than 30 days.

​
maxEntries
integer
default:10

Maximum number of entries.

Required range: 1 <= x <= 500
​
comment
string | null

Note that will be shown on the airdrop message.

Maximum string length: 256
​
allowedRoleIds
string[] | null

Roles that are allowed to enter the airdrop.

Maximum array length: 16

ID of a Discord role.

​
allowedUserIds
string[] | null

Users that are allowed to enter the airdrop.

Maximum array length: 16

ID of a Discord user.

​
forbiddenRoleIds
string[] | null

Roles that are forbidden from entering the airdrop.

Maximum array length: 16

ID of a Discord role.

​
forbiddenUserIds
string[] | null

Users that are forbidden from entering the airdrop.

Maximum array length: 16

ID of a Discord user.

Response

201

Airdrop has been created successfully