API Reference

Flipsuite API (1.1.1) specification.

All endpoints require an API key sent via x-api-key header, and have a rate limit of 1 request per second. You can generate API keys for your Flipsuite configuration on the dashboard.

To use Flipsuite API you have to activate the Starter or Pro plan in your Flipsuite configuration first. Please check our store for details about features and pricing.

💸 Tipping

Below you can find endpoints related to tipping. Every tip, airdrop or raffle made via API will use your server tipping wallet to distribute rewards, so make sure to setup one before proceeding. Once you log into the dashboard and create a Flipsuite configuration - go to the tipping tab to set it up. YouTube API usage example here.

Please note that even though the requests have a rate limit of 1 per second - your tips, airdrops and raffles can, and will be delayed by a few or more seconds if you try to create a lot of them at once.

Send automated tips in your server

post

/v1/tips

Header parameters

x-api-keystring · uuidrequired

Body

channelIdstring

ID of a Discord channel in your server where the tip should be sent.

Pattern: ^\d+$

recipientIdstring

ID of a Discord user in your server that should receive the tip.

Pattern: ^\d+$

commentstring | nullable

Note that will be shown on the tip message. Cannot be longer than 256 characters.

itemone of

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.flipguard.xyz/v1/tips' \
  --header 'x-api-key: 123e4567-e89b-12d3-a456-426614174000' \
  --header 'Content-Type: application/json' \
  --data '{"channelId":"1234567890123456789","recipientId":"1234567890123456789","comment":"Hello, world!","item":{"type":"TOKEN","chain":"Polygon","tokenAddress":"0x162539172b53e9a93b7d98fb6c41682de558a320","amount":1000}}'

201

201

No body

Tip has been sent successfully

Create automated raffles in your server

post

/v1/raffles

Header parameters

x-api-keystring · uuidrequired

Body

channelIdstring

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

Pattern: ^\d+$

countdowninteger

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

maxEntriesinteger

Maximum number of entries. Must be an integer between 1 and 500.

maxWinnersinteger · default: 1 | nullable

Maximum number of winners. Must be an integer between 1 and 100.

commentstring | nullable

Note that will be shown on the raffle message. Cannot be longer than 256 characters.

allowedRoleIdsstring[] | nullable

Roles that are allowed to enter the raffle.

allowedUserIdsstring[] | nullable

Users that are allowed to enter the raffle.

forbiddenRoleIdsstring[] | nullable

Roles that are forbidden from entering the airdrop.

forbiddenUserIdsstring[] | nullable

Users that are forbidden from entering the airdrop.

itemone of

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.flipguard.xyz/v1/raffles' \
  --header 'x-api-key: 123e4567-e89b-12d3-a456-426614174000' \
  --header 'Content-Type: application/json' \
  --data '{"channelId":"1234567890123456789","countdown":60000,"maxEntries":10,"maxWinners":5,"comment":"Hello, world!","allowedRoleIds":["12345678901234567891","12345678901234567892"],"allowedUserIds":["12345678901234567893","12345678901234567894"],"forbiddenRoleIds":["12345678901234567895","12345678901234567896"],"forbiddenUserIds":["12345678901234567897","12345678901234567898"],"item":{"type":"TOKEN","chain":"Polygon","tokenAddress":"0x162539172b53e9a93b7d98fb6c41682de558a320","amount":1000}}'

201

201

No body

Raffle has been created successfully

Create automated airdrops in your server

post

/v1/airdrops

Header parameters

x-api-keystring · uuidrequired

Body

channelIdstring

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

Pattern: ^\d+$

countdowninteger

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

maxEntriesinteger

Maximum number of entries. Must be an integer between 1 and 500.

commentstring | nullable

Note that will be shown on the airdrop message. Cannot be longer than 256 characters.

allowedRoleIdsstring[] | nullable

Roles that are allowed to enter the airdrop.

allowedUserIdsstring[] | nullable

Users that are allowed to enter the airdrop.

forbiddenRoleIdsstring[] | nullable

Roles that are forbidden from entering the airdrop.

forbiddenUserIdsstring[] | nullable

Users that are forbidden from entering the airdrop.

itemobject

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.flipguard.xyz/v1/airdrops' \
  --header 'x-api-key: 123e4567-e89b-12d3-a456-426614174000' \
  --header 'Content-Type: application/json' \
  --data '{"channelId":"1234567890123456789","countdown":60000,"maxEntries":10,"comment":"Hello, world!","allowedRoleIds":["12345678901234567891","12345678901234567892"],"allowedUserIds":["12345678901234567893","12345678901234567894"],"forbiddenRoleIds":["12345678901234567895","12345678901234567896"],"forbiddenUserIds":["12345678901234567897","12345678901234567898"],"item":{"type":"TOKEN","chain":"Polygon","tokenAddress":"0x162539172b53e9a93b7d98fb6c41682de558a320","amount":1000}}'

201

201

No body

Airdrop has been created successfully