Create Loyalty Rule

POST

api

loyalty

rules

object

organizationId

string

websiteId

string

backgroundAssetUrl

string

name

string

description

string

network

enum<string>

type

enum<string>

frequency

enum<string>

interval

enum<string>

startTime

string

endTime

string

effectiveStartTime

Effective Start Time · string

effectiveEndTime

Effective End Time · string

amount

Amount · null

customRewardsCsvUrl

string

customRewardsApiUrl

string

subscriptionIdentifier

string

metadata

object

onlyNonListed

boolean

hasPaidFullRoyalty

boolean

hasVerifiedTwitter

boolean

hasNeverSold

boolean

onlyNative

boolean

twitterUsername

string

twitterUserId

string

twitterHashtag

string

enableVerifiedMultiplier

boolean

verifiedMultiplier

number

isMultiplierApplied

boolean

onlyKnownUsers

boolean

firstReferralReward

number

referrerReward

number

secondReferralReward

number

enableStreaks

boolean

promoCode

string

enableJoinDiscordServers

boolean

discordServersToJoin

array

streakArray

array

dripQuestsToComplete

array

collection

array

range

array

customRewardsApiKey

string

link

string

socialPlatform

enum<string>

socialPlatformName

string

socialPlatformLogo

string

rewardPerImpression

boolean

minQty

number

maxQty

number

snapshotProposals

array

cta

object

label

string

href

string

hasSaleCurrency

boolean

isTokenHoldMultiplier

boolean

saleCurrency

string

isRetroactive

boolean

timeDelayToVerifySeconds

string

referralRequirements

object

points

object

amount

number

loyaltyCurrecyId

string

achievePoints

boolean

completeProfile

boolean

connectTwitter

boolean

connectDiscord

boolean

connectEmail

boolean

multiplierLoyaltyCurrencyIds

array

verifyPlaceHolderText

string

verificationTextMinimumLength

integer

buttonText

string

telegramChannelId

string

twitterAccountUrl

string

twitterPostUrl

string

checkLike

boolean

checkRepost

boolean

checkComment

boolean

checkText

string

smartContract

object

contractId

string

abi

string

event

string

criteria

enum<string>

params

array

withCustomRange

boolean

customRange

object

startsAt

string

endsAt

string

withMax

boolean

max

number

withBonus

boolean

bonus

array

addressMapping

string

walletType

enum<string>

imageUrl

string

collectionAddress

string

collections

array

hideInUi

boolean

isRequired

boolean

oauthCredentialsId

string

loyaltyCurrencyId

string

loyaltyRuleGroupId

enum<string>

rewardType

enum<string>

Authorizations

X-API-KEY

string

headerrequired

Body

application/json

Schema for creating a new loyalty rule with detailed validations

organizationId

string

required

Unique identifier for the organization creating the rule

websiteId

string

required

Unique identifier for the associated website

name

string

required

Name of the loyalty rule

Minimum length: 1

type

enum<string>

required

Type of loyalty rule being created

Available options:

Bonus,

BoughtOn,

BoughtWithRoyalties,

DiscordMessages,

Listing,

Lodging,

MintOn,

PoapClaim,

SnagSocialsConnected,

SnapshotFullset,

SnapshotHold,

SoldOn,

SoldWithRoyalties,

TokenHold,

TwitterBio,

TwitterHashTagPost,

Retweet,

twitter_follow,

twitter_like,

twitter_comment,

connected_discord,

connected_twitter,

connected_email,

profile_completed,

referred_user,

code_entry,

check_in,

external_rule,

link_click,

tweet_liked_by_project,

twitter_post_hashtag,

token_hold_erc20,

snapshot_governance,

twitter_followers,

discord_member,

text_input,

telegram_messages,

drip_x_follow,

drip_x_tweet,

drip_x_new_tweet,

drip_x_text_in_bio,

drip_x_text_in_name,

drip_x_text_in_comment,

smart_contract_event,

create_partner_account,

telegram_join,

connected_telegram,

manual_upload,

connect_wallet,

connected_steam

frequency

enum<string>

required

Execution frequency of the loyalty rule

Available options:

none,

once,

daily,

weekly,

monthly,

immediately

startTime

string | null

required

When the rule becomes active

endTime

string | null

required

When the rule becomes inactive

effectiveStartTime

required

The effective start time of the rule

effectiveEndTime

required

The effective end time of the rule

amount

any | null

required

Reward amount associated with the rule

metadata

object

required

Additional metadata for the loyalty rule

metadata.onlyNonListed

boolean

Flag indicating whether to include only non-listed items.

metadata.hasPaidFullRoyalty

boolean

Indicates if the full royalty has been paid for items.

metadata.hasVerifiedTwitter

boolean

Indicates if the user has a verified Twitter account.

metadata.hasNeverSold

boolean

Indicates if the item has never been sold.

metadata.onlyNative

boolean

Flag indicating whether to include only native tokens.

metadata.twitterUsername

string

Twitter username of the user.

metadata.twitterUserId

string

Unique identifier of the Twitter user.

metadata.twitterHashtag

string

Hashtag associated with the Twitter post.

metadata.enableVerifiedMultiplier

boolean

Flag indicating whether the verified multiplier is enabled.

metadata.verifiedMultiplier

number | null

Multiplier applied to rewards for verified users.

metadata.isMultiplierApplied

boolean

Indicates if the multiplier has been applied to rewards.

metadata.onlyKnownUsers

boolean

Flag indicating whether to include only known users.

metadata.firstReferralReward

number | null

Percentage reward given to a user for their first referral.

metadata.referrerReward

number | null

Lump sum reward given to a referrer.

metadata.secondReferralReward

number | null

Percentage reward given for a second-level referral.

metadata.enableStreaks

boolean | null

Flag indicating whether streaks are enabled.

Promotional code associated with the rule.

metadata.enableJoinDiscordServers

boolean | null

Flag indicating whether joining Discord servers is required.

metadata.discordServersToJoin

object[] | null

Array of Discord servers, channels, and roles to join.

metadata.streakArray

object[] | null

Array of streak milestones and corresponding rewards.

metadata.dripQuestsToComplete

object[] | null

Array of drip quests required to complete the rule.

metadata.collection

object[]

Array of collections associated with the rule.

metadata.range

object[]

Array defining ranges and corresponding rewards.

metadata.customRewardsApiKey

string

API key for custom rewards integration.

metadata.link

string | null

Optional link associated with the metadata.

Social media platform associated with the rule.

Available options:

Twitch,

TikTok,

X(Twitter),

Instagram,

EpicGames,

YouTube,

Discord,

Custom

Name of the social platform.

URL of the social platform's logo.

metadata.rewardPerImpression

boolean | null

Flag indicating if rewards are given per impression.

metadata.minQty

number | null

Minimum quantity constraint for token holding.

metadata.maxQty

number | null

Maximum quantity constraint for token holding.

metadata.snapshotProposals

object[] | null

Array of snapshot proposals for the rule.

metadata.cta

object | null

Object containing details for the call-to-action.

metadata.hasSaleCurrency

boolean

Flag indicating if the sale currency is included.

metadata.isTokenHoldMultiplier

boolean

default: true

Flag indicating if the token hold multiplier is applied.

metadata.saleCurrency

string

Currency associated with sales.

metadata.isRetroactive

boolean | null

Flag indicating if rewards are applied retroactively.

metadata.timeDelayToVerifySeconds

Time delay in seconds to verify actions.

metadata.referralRequirements

object | null

Object defining referral requirements.

metadata.multiplierLoyaltyCurrencyIds

string[] | null

Array of loyalty currency IDs used for multipliers.

metadata.verifyPlaceHolderText

string | null

Placeholder text for verification input fields.

metadata.verificationTextMinimumLength

integer | null

Minimum length of the verification text.

metadata.buttonText

string | null

Text displayed on the action button.

metadata.telegramChannelId

string | null

ID of the Telegram channel.

metadata.twitterAccountUrl

string

URL of the associated Twitter account.

metadata.twitterPostUrl

string

URL of the associated Twitter post.

metadata.checkLike

boolean | null

Flag indicating if liking the post is required.

metadata.checkRepost

boolean | null

Flag indicating if reposting is required.

metadata.checkComment

boolean | null

Flag indicating if commenting is required.

metadata.checkText

string | null

Text to check in the Twitter post, username, or bio.

metadata.smartContract

object

Object containing details of the associated smart contract.

metadata.walletType

enum<string> | null

Type of wallet associated with the rule.

Available options:

evm,

solana,

imx,

sui,

ton

metadata.imageUrl

string | null

URL of the image associated with the rule.

loyaltyCurrencyId

string

required

Unique identifier for the loyalty currency

backgroundAssetUrl

string

URL of the background asset to be displayed

description

string

Optional detailed description of the rule

network

enum<string>

default: mainnet

Blockchain network where the rule will apply

Available options:

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

interval

enum<string> | null

Interval between rule executions

Available options:

daily,

weekly,

monthly,

once

customRewardsCsvUrl

string | null

URL for uploading custom rewards via CSV

customRewardsApiUrl

string | null

URL for fetching custom rewards

subscriptionIdentifier

string | null

Identifier for associated subscriptions

collectionAddress

string

Blockchain address of the associated collection

collections

object[] | null

List of associated collections

hideInUi

boolean

default: false

Whether to hide this rule in the user interface

isRequired

boolean

default: false

Whether this rule is mandatory

oauthCredentialsId

string | null

OAuth credentials associated with the rule

loyaltyRuleGroupId

Unique identifier for the loyalty rule group

Available options:

no-section

rewardType

enum<string>

default: points

Type of reward issued by the rule

Available options:

points,

multiplier

Response

200 - application/json

Schema for creating a new loyalty rule with detailed validations

string

required

organizationId

string

required

Unique identifier for the organization creating the rule

websiteId

string

required

Unique identifier for the associated website

name

string

required

Name of the loyalty rule

Minimum length: 1

type

enum<string>

required

Type of loyalty rule being created

Available options:

Bonus,

BoughtOn,

BoughtWithRoyalties,

DiscordMessages,

Listing,

Lodging,

MintOn,

PoapClaim,

SnagSocialsConnected,

SnapshotFullset,

SnapshotHold,

SoldOn,

SoldWithRoyalties,

TokenHold,

TwitterBio,

TwitterHashTagPost,

Retweet,

twitter_follow,

twitter_like,

twitter_comment,

connected_discord,

connected_twitter,

connected_email,

profile_completed,

referred_user,

code_entry,

check_in,

external_rule,

link_click,

tweet_liked_by_project,

twitter_post_hashtag,

token_hold_erc20,

snapshot_governance,

twitter_followers,

discord_member,

text_input,

telegram_messages,

drip_x_follow,

drip_x_tweet,

drip_x_new_tweet,

drip_x_text_in_bio,

drip_x_text_in_name,

drip_x_text_in_comment,

smart_contract_event,

create_partner_account,

telegram_join,

connected_telegram,

manual_upload,

connect_wallet,

connected_steam

frequency

enum<string>

required

Execution frequency of the loyalty rule

Available options:

none,

once,

daily,

weekly,

monthly,

immediately

startTime

string | null

required

When the rule becomes active

endTime

string | null

required

When the rule becomes inactive

effectiveStartTime

required

The effective start time of the rule

effectiveEndTime

required

The effective end time of the rule

amount

any | null

required

Reward amount associated with the rule

metadata

object

required

Additional metadata for the loyalty rule

metadata.onlyNonListed

boolean

Flag indicating whether to include only non-listed items.

metadata.hasPaidFullRoyalty

boolean

Indicates if the full royalty has been paid for items.

metadata.hasVerifiedTwitter

boolean

Indicates if the user has a verified Twitter account.

metadata.hasNeverSold

boolean

Indicates if the item has never been sold.

metadata.onlyNative

boolean

Flag indicating whether to include only native tokens.

metadata.twitterUsername

string

Twitter username of the user.

metadata.twitterUserId

string

Unique identifier of the Twitter user.

metadata.twitterHashtag

string

Hashtag associated with the Twitter post.

metadata.enableVerifiedMultiplier

boolean

Flag indicating whether the verified multiplier is enabled.

metadata.verifiedMultiplier

number | null

Multiplier applied to rewards for verified users.

metadata.isMultiplierApplied

boolean

Indicates if the multiplier has been applied to rewards.

metadata.onlyKnownUsers

boolean

Flag indicating whether to include only known users.

metadata.firstReferralReward

number | null

Percentage reward given to a user for their first referral.

metadata.referrerReward

number | null

Lump sum reward given to a referrer.

metadata.secondReferralReward

number | null

Percentage reward given for a second-level referral.

metadata.enableStreaks

boolean | null

Flag indicating whether streaks are enabled.

Promotional code associated with the rule.

metadata.enableJoinDiscordServers

boolean | null

Flag indicating whether joining Discord servers is required.

metadata.discordServersToJoin

object[] | null

Array of Discord servers, channels, and roles to join.

metadata.streakArray

object[] | null

Array of streak milestones and corresponding rewards.

metadata.dripQuestsToComplete

object[] | null

Array of drip quests required to complete the rule.

metadata.collection

object[]

Array of collections associated with the rule.

metadata.range

object[]

Array defining ranges and corresponding rewards.

metadata.customRewardsApiKey

string

API key for custom rewards integration.

metadata.link

string | null

Optional link associated with the metadata.

Social media platform associated with the rule.

Available options:

Twitch,

TikTok,

X(Twitter),

Instagram,

EpicGames,

YouTube,

Discord,

Custom

Name of the social platform.

URL of the social platform's logo.

metadata.rewardPerImpression

boolean | null

Flag indicating if rewards are given per impression.

metadata.minQty

number | null

Minimum quantity constraint for token holding.

metadata.maxQty

number | null

Maximum quantity constraint for token holding.

metadata.snapshotProposals

object[] | null

Array of snapshot proposals for the rule.

metadata.cta

object | null

Object containing details for the call-to-action.

metadata.hasSaleCurrency

boolean

Flag indicating if the sale currency is included.

metadata.isTokenHoldMultiplier

boolean

default: true

Flag indicating if the token hold multiplier is applied.

metadata.saleCurrency

string

Currency associated with sales.

metadata.isRetroactive

boolean | null

Flag indicating if rewards are applied retroactively.

metadata.timeDelayToVerifySeconds

number

Time delay in seconds to verify actions.

metadata.referralRequirements

object | null

Object defining referral requirements.

metadata.multiplierLoyaltyCurrencyIds

string[] | null

Array of loyalty currency IDs used for multipliers.

metadata.verifyPlaceHolderText

string | null

Placeholder text for verification input fields.

metadata.verificationTextMinimumLength

integer | null

Minimum length of the verification text.

metadata.buttonText

string | null

Text displayed on the action button.

metadata.telegramChannelId

string | null

ID of the Telegram channel.

metadata.twitterAccountUrl

string

URL of the associated Twitter account.

metadata.twitterPostUrl

string

URL of the associated Twitter post.

metadata.checkLike

boolean | null

Flag indicating if liking the post is required.

metadata.checkRepost

boolean | null

Flag indicating if reposting is required.

metadata.checkComment

boolean | null

Flag indicating if commenting is required.

metadata.checkText

string | null

Text to check in the Twitter post, username, or bio.

metadata.smartContract

object

Object containing details of the associated smart contract.

metadata.walletType

enum<string> | null

Type of wallet associated with the rule.

Available options:

evm,

solana,

imx,

sui,

ton

metadata.imageUrl

string | null

URL of the image associated with the rule.

loyaltyCurrencyId

string

required

Unique identifier for the loyalty currency

backgroundAssetUrl

string

URL of the background asset to be displayed

description

string

Optional detailed description of the rule

network

enum<string>

default: mainnet

Blockchain network where the rule will apply

Available options:

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

interval

enum<string> | null

Interval between rule executions

Available options:

daily,

weekly,

monthly,

once

customRewardsCsvUrl

string | null

URL for uploading custom rewards via CSV

customRewardsApiUrl

string | null

URL for fetching custom rewards

subscriptionIdentifier

string | null

Identifier for associated subscriptions

collectionAddress

string

Blockchain address of the associated collection

collections

object[] | null

List of associated collections

hideInUi

boolean

default: false

Whether to hide this rule in the user interface

isRequired

boolean

default: false

Whether this rule is mandatory

oauthCredentialsId

string | null

OAuth credentials associated with the rule

loyaltyRuleGroupId

Unique identifier for the loyalty rule group

Available options:

no-section

rewardType

enum<string>

default: points

Type of reward issued by the rule

Available options:

points,

multiplier

Get Loyalty Rules Update Loyalty Rule

API Documentation

Assets

Identity

Loyalty

Badges

Auctions

Drip

Websites

Create Loyalty Rule

Authorizations

Body

Response