API Documentation
Assets
Identity
Loyalty
- GETGet Loyalty Rules
- POSTCreate Loyalty Rule
- POSTUpdate Loyalty Rule
- DELDelete Loyalty Rule
- POSTComplete Loyalty Rule
- GETGet Processing status for a specific user on loyalty rules
- GETGet Loyalty Rule Edits
- POSTRestore Loyalty Rule Edit
- GETGet loyalty accounts
- GETGet loyalty currencies
- POSTCreate a loyalty currency
- GETGet Loyalty Multipliers
- POSTCreate Loyalty Multiplier
- DELDelete Loyalty Multiplier by External Identifier
- POSTUpdate Loyalty Multiplier
- DELDelete Loyalty Multiplier by ID
- GETGet Loyalty Transaction Entries
Drip
Update Loyalty Rule
Update an existing Loyalty Rule
Name of the loyalty rule
Optional description of the loyalty rule
Start time for the loyalty rule
End time for the loyalty rule
Effective start time of the rule
Effective end time of the rule
Reward amount for the loyalty rule
URL for uploading custom rewards via CSV
API URL for custom rewards integration
Optional subscription identifier for the rule
Additional metadata for the loyalty rule
Flag indicating whether to include only non-listed items.
Indicates if the full royalty has been paid for items.
Indicates if the user has a verified Twitter account.
Indicates if the item has never been sold.
Flag indicating whether to include only native tokens.
Twitter username of the user.
Unique identifier of the Twitter user.
Hashtag associated with the Twitter post.
Flag indicating whether the verified multiplier is enabled.
Multiplier applied to rewards for verified users.
Indicates if the multiplier has been applied to rewards.
Flag indicating whether to include only known users.
Percentage reward given to a user for their first referral.
Lump sum reward given to a referrer.
Percentage reward given for a second-level referral.
Flag indicating whether streaks are enabled.
Promotional code associated with the rule.
Flag indicating whether joining Discord servers is required.
Array of Discord servers, channels, and roles to join.
Array of streak milestones and corresponding rewards.
Array of drip quests required to complete the rule.
Array of collections associated with the rule.
Array defining ranges and corresponding rewards.
API key for custom rewards integration.
Optional link associated with the metadata.
Social media platform associated with the rule.
Name of the social platform.
URL of the social platform's logo.
Flag indicating if rewards are given per impression.
Minimum quantity constraint for token holding.
Maximum quantity constraint for token holding.
Array of snapshot proposals for the rule.
Object containing details for the call-to-action.
Label for the call-to-action.
Link for the call-to-action.
Flag indicating if the sale currency is included.
Flag indicating if the token hold multiplier is applied.
Currency associated with sales.
Flag indicating if rewards are applied retroactively.
Time delay in seconds to verify actions.
Object defining referral requirements.
Points required for referral.
ID of the loyalty currency for referral.
Flag indicating if achieving points is required.
Flag indicating if completing the profile is required.
Flag indicating if connecting Twitter is required.
Flag indicating if connecting Discord is required.
Flag indicating if connecting email is required.
Array of loyalty currency IDs used for multipliers.
Placeholder text for verification input fields.
Minimum length of the verification text.
Text displayed on the action button.
ID of the Telegram channel.
URL of the associated Twitter account.
URL of the associated Twitter post.
Flag indicating if liking the post is required.
Flag indicating if reposting is required.
Flag indicating if commenting is required.
Text to check in the Twitter post, username, or bio.
Object containing details of the associated smart contract.
ID of the smart contract.
ABI of the smart contract.
Event emitted by the smart contract.
Criteria to evaluate the smart contract event.
Array of parameters for the smart contract.
Flag indicating if a custom range is applied.
Time range applied to the rule.
Start time of the custom range.
End time of the custom range.
Flag indicating if a maximum limit is applied.
Maximum value allowed for the parameter.
Flag indicating if a bonus is applied.
Array of bonus details applied to the rule.
Mapping of addresses for the smart contract.
Type of wallet associated with the rule.
URL of the image associated with the rule.
Whether to hide this rule in the user interface
Whether this rule is required for participation
ID for associated OAuth credentials
Type of reward issued by this rule
Frequency of the rule execution
Time interval for recurring rule execution
ID of the rule group section to associate with the rule
Authorizations
Path Parameters
Body
Name of the loyalty rule
1Start time for the loyalty rule
End time for the loyalty rule
Effective start time of the rule
Effective end time of the rule
Reward amount for the loyalty rule
Additional metadata for the loyalty rule
Flag indicating whether to include only non-listed items.
Indicates if the full royalty has been paid for items.
Indicates if the user has a verified Twitter account.
Indicates if the item has never been sold.
Flag indicating whether to include only native tokens.
Twitter username of the user.
Unique identifier of the Twitter user.
Hashtag associated with the Twitter post.
Flag indicating whether the verified multiplier is enabled.
Multiplier applied to rewards for verified users.
Indicates if the multiplier has been applied to rewards.
Flag indicating whether to include only known users.
Percentage reward given to a user for their first referral.
Lump sum reward given to a referrer.
Percentage reward given for a second-level referral.
Flag indicating whether streaks are enabled.
Promotional code associated with the rule.
Flag indicating whether joining Discord servers is required.
Array of Discord servers, channels, and roles to join.
ID of the Discord server to join.
Array of drip quests required to complete the rule.
ID of the drip quest to complete.
Array of collections associated with the rule.
Blockchain address of the collection.
Blockchain network of the collection.
mainnet, polygon, polygon_mumbai, optimism, arbitrum, binance, bscTestnet, avalanche, avalancheFuji, zksync, fantom, fantomTestnet, base, baseSepolia, skaleNebula, xai, berachainArtio, solana, apechain, flowMainnet, campTestnet, sui, vanar, sepolia, optimism_sepolia, arbitrumSepolia, goerli, optimism_goerli, arbitrumGoerli Multiplier applied to the rewards for this collection.
API key for custom rewards integration.
Optional link associated with the metadata.
Social media platform associated with the rule.
Twitch, TikTok, X(Twitter), Instagram, EpicGames, YouTube, Discord, Custom Name of the social platform.
URL of the social platform's logo.
Flag indicating if rewards are given per impression.
Minimum quantity constraint for token holding.
Maximum quantity constraint for token holding.
Flag indicating if the sale currency is included.
Flag indicating if the token hold multiplier is applied.
Currency associated with sales.
Flag indicating if rewards are applied retroactively.
Time delay in seconds to verify actions.
Object defining referral requirements.
Flag indicating if achieving points is required.
Flag indicating if completing the profile is required.
Flag indicating if connecting Twitter is required.
Flag indicating if connecting Discord is required.
Flag indicating if connecting email is required.
Array of loyalty currency IDs used for multipliers.
Placeholder text for verification input fields.
Minimum length of the verification text.
Text displayed on the action button.
ID of the Telegram channel.
URL of the associated Twitter account.
URL of the associated Twitter post.
Flag indicating if liking the post is required.
Flag indicating if reposting is required.
Flag indicating if commenting is required.
Text to check in the Twitter post, username, or bio.
Object containing details of the associated smart contract.
ID of the smart contract.
ABI of the smart contract.
Event emitted by the smart contract.
Criteria to evaluate the smart contract event.
everyEvent, byParameter Flag indicating if a custom range is applied.
Flag indicating if a maximum limit is applied.
Maximum value allowed for the parameter.
Flag indicating if a bonus is applied.
Mapping of addresses for the smart contract.
Type of wallet associated with the rule.
evm, solana, imx, sui, ton URL of the image associated with the rule.
Frequency of the rule execution
none, once, daily, weekly, monthly, immediately Optional description of the loyalty rule
URL for uploading custom rewards via CSV
API URL for custom rewards integration
Optional subscription identifier for the rule
Whether to hide this rule in the user interface
Whether this rule is required for participation
ID for associated OAuth credentials
Type of reward issued by this rule
points, multiplier Time interval for recurring rule execution
daily, weekly, monthly, once ID of the rule group section to associate with the rule
Response
Name of the loyalty rule
1Start time for the loyalty rule
End time for the loyalty rule
Effective start time of the rule
Effective end time of the rule
Reward amount for the loyalty rule
Additional metadata for the loyalty rule
Flag indicating whether to include only non-listed items.
Indicates if the full royalty has been paid for items.
Indicates if the user has a verified Twitter account.
Indicates if the item has never been sold.
Flag indicating whether to include only native tokens.
Twitter username of the user.
Unique identifier of the Twitter user.
Hashtag associated with the Twitter post.
Flag indicating whether the verified multiplier is enabled.
Multiplier applied to rewards for verified users.
Indicates if the multiplier has been applied to rewards.
Flag indicating whether to include only known users.
Percentage reward given to a user for their first referral.
Lump sum reward given to a referrer.
Percentage reward given for a second-level referral.
Flag indicating whether streaks are enabled.
Promotional code associated with the rule.
Flag indicating whether joining Discord servers is required.
Array of Discord servers, channels, and roles to join.
ID of the Discord server to join.
Array of drip quests required to complete the rule.
ID of the drip quest to complete.
Array of collections associated with the rule.
Blockchain address of the collection.
Blockchain network of the collection.
mainnet, polygon, polygon_mumbai, optimism, arbitrum, binance, bscTestnet, avalanche, avalancheFuji, zksync, fantom, fantomTestnet, base, baseSepolia, skaleNebula, xai, berachainArtio, solana, apechain, flowMainnet, campTestnet, sui, vanar, sepolia, optimism_sepolia, arbitrumSepolia, goerli, optimism_goerli, arbitrumGoerli Multiplier applied to the rewards for this collection.
API key for custom rewards integration.
Optional link associated with the metadata.
Social media platform associated with the rule.
Twitch, TikTok, X(Twitter), Instagram, EpicGames, YouTube, Discord, Custom Name of the social platform.
URL of the social platform's logo.
Flag indicating if rewards are given per impression.
Minimum quantity constraint for token holding.
Maximum quantity constraint for token holding.
Flag indicating if the sale currency is included.
Flag indicating if the token hold multiplier is applied.
Currency associated with sales.
Flag indicating if rewards are applied retroactively.
Time delay in seconds to verify actions.
Object defining referral requirements.
Flag indicating if achieving points is required.
Flag indicating if completing the profile is required.
Flag indicating if connecting Twitter is required.
Flag indicating if connecting Discord is required.
Flag indicating if connecting email is required.
Array of loyalty currency IDs used for multipliers.
Placeholder text for verification input fields.
Minimum length of the verification text.
Text displayed on the action button.
ID of the Telegram channel.
URL of the associated Twitter account.
URL of the associated Twitter post.
Flag indicating if liking the post is required.
Flag indicating if reposting is required.
Flag indicating if commenting is required.
Text to check in the Twitter post, username, or bio.
Object containing details of the associated smart contract.
ID of the smart contract.
ABI of the smart contract.
Event emitted by the smart contract.
Criteria to evaluate the smart contract event.
everyEvent, byParameter Flag indicating if a custom range is applied.
Flag indicating if a maximum limit is applied.
Maximum value allowed for the parameter.
Flag indicating if a bonus is applied.
Mapping of addresses for the smart contract.
Type of wallet associated with the rule.
evm, solana, imx, sui, ton URL of the image associated with the rule.
Frequency of the rule execution
none, once, daily, weekly, monthly, immediately Optional description of the loyalty rule
URL for uploading custom rewards via CSV
API URL for custom rewards integration
Optional subscription identifier for the rule
Whether to hide this rule in the user interface
Whether this rule is required for participation
ID for associated OAuth credentials
Type of reward issued by this rule
points, multiplier Time interval for recurring rule execution
daily, weekly, monthly, once ID of the rule group section to associate with the rule