Create Loyalty Rule

POST

api

loyalty

rules

import SnagSolutions from '@snagsolutions/sdk';

const client = new SnagSolutions({
  apiKey: process.env['X_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const rule = await client.loyalty.rules.create({
    amount: '10.5',
    effectiveEndTime: '2024-12-31T23:59:00Z',
    effectiveStartTime: '2024-01-01T00:00:00Z',
    endTime: '2024-12-31T23:59:00Z',
    frequency: 'none',
    loyaltyCurrencyId: '456e1234-e89b-12d3-a456-426614174003',
    metadata: {},
    name: 'Referral Bonus Rule',
    organizationId: '123e4567-e89b-12d3-a456-426614174001',
    startTime: '2024-01-01T00:00:00Z',
    type: 'Bonus',
    websiteId: '123e4567-e89b-12d3-a456-426614174002',
  });

  console.log(rule.id);
}

main();

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "123e4567-e89b-12d3-a456-426614174001",
  "websiteId": "123e4567-e89b-12d3-a456-426614174002",
  "backgroundAssetUrl": "https://example.com/background.png",
  "name": "Referral Bonus Rule",
  "description": "A loyalty rule rewarding users for referrals.",
  "network": "mainnet",
  "type": "Bonus",
  "frequency": "daily",
  "interval": "weekly",
  "startTime": "2024-01-01T00:00:00Z",
  "endTime": "2024-12-31T23:59:00Z",
  "effectiveStartTime": "2024-01-01T00:00:00Z",
  "effectiveEndTime": "2024-12-31T23:59:00Z",
  "amount": "<any>",
  "customRewardsCsvUrl": "https://example.com/rewards.csv",
  "customRewardsApiUrl": "https://api.example.com/rewards",
  "subscriptionIdentifier": "sub12345",
  "metadata": {
    "onlyNonListed": true,
    "hasPaidFullRoyalty": false,
    "hasVerifiedTwitter": true,
    "onlyRewardExistingUser": true,
    "hasNeverSold": false,
    "onlyNative": true,
    "hasFillSource": true,
    "fillSource": "opensea.io",
    "hasOrderSource": true,
    "orderSource": "opensea.io",
    "twitterUsername": "@example_user",
    "twitterUserId": "1234567890",
    "twitterHashtag": "#loyalty",
    "enableVerifiedMultiplier": true,
    "verifiedMultiplier": 1.5,
    "isMultiplierApplied": true,
    "onlyKnownUsers": false,
    "firstReferralReward": 10,
    "referrerReward": 50,
    "secondReferralReward": 5,
    "enableStreaks": true,
    "promoCode": "PROMO123",
    "enableJoinDiscordServers": true,
    "discordServersToJoin": [
      {
        "id": "123456789012345678",
        "channels": [
          {
            "id": "987654321098765432",
            "text": "Hello",
            "emojis": [
              {
                "id": "1f600"
              }
            ]
          }
        ],
        "roles": [
          {
            "id": "role123"
          }
        ]
      }
    ],
    "streakArray": [
      {
        "streakMilestone": 5,
        "streakAmount": 10
      }
    ],
    "dripQuestsToComplete": [
      {
        "id": "drip123"
      }
    ],
    "collection": [
      {
        "address": "0xabcdefabcdefabcdefabcdefabcdefabcdef",
        "network": "mainnet",
        "multiplier": 2
      }
    ],
    "range": [
      {
        "startRange": 1,
        "endRange": 10,
        "amount": 5
      }
    ],
    "customRewardsApiKey": "api-key-1234",
    "link": "https://example.com",
    "socialPlatform": "X(Twitter)",
    "socialPlatformName": "Twitter",
    "socialPlatformLogo": "https://example.com/logo.png",
    "rewardPerImpression": true,
    "minQty": 1,
    "maxQty": 10,
    "snapshotProposals": [
      {
        "id": "proposal123",
        "space": "space123"
      }
    ],
    "cta": {
      "label": "Click Here",
      "href": "https://example.com"
    },
    "hasSaleCurrency": false,
    "isTokenHoldMultiplier": true,
    "saleCurrency": "USD",
    "isRetroactive": true,
    "timeDelayToVerifySeconds": 300,
    "referralRequirements": {
      "points": {
        "amount": 50,
        "loyaltyCurrecyId": "currency123"
      },
      "achievePoints": true,
      "completeProfile": false,
      "connectTwitter": true,
      "connectDiscord": true,
      "connectEmail": true
    },
    "multiplierLoyaltyCurrencyIds": [
      "currency123",
      "currency456"
    ],
    "verifyPlaceHolderText": "Enter your verification code here.",
    "verificationTextMinimumLength": 10,
    "buttonText": "Verify Now",
    "telegramChannelId": "telegram-channel-123",
    "twitterAccountUrl": "https://twitter.com/example_user",
    "twitterPostUrl": "https://twitter.com/example/status/1234567890",
    "checkLike": true,
    "checkRepost": true,
    "checkComment": true,
    "checkText": "loyalty",
    "smartContract": {
      "contractId": "123e4567-e89b-12d3-a456-426614174000",
      "abi": "[]",
      "event": "Transfer",
      "criteria": "everyEvent",
      "params": [
        {
          "name": "value",
          "condition": ">=",
          "value": "100"
        }
      ],
      "withCustomRange": true,
      "customRange": {
        "startsAt": "2024-01-01T00:00:00Z",
        "endsAt": "2024-01-31T23:59:59Z"
      },
      "withMax": true,
      "max": 1000,
      "withBonus": true,
      "bonus": [
        {
          "amount": 50,
          "count": 5
        }
      ],
      "addressMapping": "0x123...789"
    },
    "walletType": "evm",
    "imageUrl": "https://example.com/image.png",
    "trackAllContracts": true,
    "onlyRewardSingleTokenOwnership": true,
    "skipMultiplier": true,
    "completeProfileConditions": {
      "twitter": true,
      "discord": false
    }
  },
  "collectionAddress": "0x1234567890abcdef1234567890abcdef12345678",
  "collections": [
    {
      "address": "0xabcdefabcdefabcdefabcdefabcdefabcdef",
      "network": "mainnet"
    }
  ],
  "hideInUi": false,
  "isRequired": true,
  "oauthCredentialsId": "123e4567-e89b-12d3-a456-426614174003",
  "loyaltyCurrencyId": "456e1234-e89b-12d3-a456-426614174003",
  "loyaltyRuleGroupId": "123e4567-e89b-12d3-a456-426614174004",
  "rewardType": "points",
  "mediaUrl": "https://example.com/media.png"
}

Authorizations

X-API-KEY

string

header

required

Body

application/json

Body

Schema for creating a new loyalty rule with detailed validations

organizationId

string

required

Unique identifier for the organization creating the rule

Example:

"123e4567-e89b-12d3-a456-426614174001"

websiteId

string

required

Unique identifier for the associated website

Example:

"123e4567-e89b-12d3-a456-426614174002"

name

string

required

Name of the loyalty rule

Minimum length: 1

Example:

"Referral Bonus Rule"

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,

check_in,

code_entry,

connect_wallet,

connected_discord,

connected_email,

connected_epic,

connected_steam,

connected_telegram,

connected_twitter,

create_partner_account,

discord_member,

drip_x_follow,

drip_x_new_tweet,

drip_x_text_in_bio,

drip_x_text_in_comment,

drip_x_text_in_name,

drip_x_tweet,

external_rule,

link_click,

manual_upload,

profile_completed,

referred_user,

smart_contract_event,

snapshot_governance,

telegram_join,

telegram_messages,

text_input,

token_hold_erc20,

tweet_liked_by_project,

twitter_comment,

twitter_follow,

twitter_followers,

twitter_like,

twitter_post_hashtag,

quiz,

poll

Example:

"Bonus"

frequency

enum<string>

required

Execution frequency of the loyalty rule

Available options:

none,

once,

daily,

weekly,

monthly,

immediately

Example:

"daily"

startTime

string | null

required

When the rule becomes active

Example:

"2024-01-01T00:00:00Z"

endTime

string | null

required

When the rule becomes inactive

Example:

"2024-12-31T23:59:00Z"

effectiveStartTime

required

The effective start time of the rule

Example:

"2024-01-01T00:00:00Z"

effectiveEndTime

required

The effective end time of the rule

Example:

"2024-12-31T23:59:00Z"

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.

Example:

true

metadata.hasPaidFullRoyalty

boolean

Indicates if the full royalty has been paid for items.

Example:

false

metadata.hasVerifiedTwitter

boolean

Indicates if the user has a verified Twitter account.

Example:

true

metadata.onlyRewardExistingUser

boolean

Indicates if only existing users are rewarded.

Example:

true

metadata.hasNeverSold

boolean

Indicates if the item has never been sold.

Example:

false

metadata.onlyNative

boolean

Flag indicating whether to include only native tokens.

Example:

true

metadata.hasFillSource

boolean

Flag indicating whether the fill source is included.

Example:

true

metadata.fillSource

string

Fill source of the order for the token sale

Example:

"opensea.io"

metadata.hasOrderSource

boolean

Flag indicating whether the order source is included.

Example:

true

metadata.orderSource

string

Order source of the order for the token sale

Example:

"opensea.io"

metadata.twitterUsername

string

Twitter username of the user.

Example:

"@example_user"

metadata.twitterUserId

string

Unique identifier of the Twitter user.

Example:

"1234567890"

metadata.twitterHashtag

string

Hashtag associated with the Twitter post.

Example:

"#loyalty"

metadata.enableVerifiedMultiplier

boolean

Flag indicating whether the verified multiplier is enabled.

Example:

true

metadata.verifiedMultiplier

number | null

Multiplier applied to rewards for verified users.

Example:

1.5

metadata.isMultiplierApplied

boolean

Indicates if the multiplier has been applied to rewards.

Example:

true

metadata.onlyKnownUsers

boolean

Flag indicating whether to include only known users.

Example:

false

metadata.firstReferralReward

number | null

Percentage reward given to a user for their first referral.

Example:

10

metadata.referrerReward

number | null

Lump sum reward given to a referrer.

Example:

50

metadata.secondReferralReward

number | null

Percentage reward given for a second-level referral.

Example:

5

metadata.enableStreaks

boolean | null

Flag indicating whether streaks are enabled.

Example:

true

Promotional code associated with the rule.

Example:

"PROMO123"

metadata.enableJoinDiscordServers

boolean | null

Flag indicating whether joining Discord servers is required.

Example:

true

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.

Example:

"api-key-1234"

metadata.link

string | null

Optional link associated with the metadata.

Example:

"https://example.com"

Social media platform associated with the rule.

Available options:

Custom,

Discord,

EpicGames,

Instagram,

Steam,

Telegram,

TikTok,

Twitch,

X(Twitter),

YouTube

Example:

"X(Twitter)"

Name of the social platform.

Example:

"Twitter"

URL of the social platform's logo.

Example:

"https://example.com/logo.png"

metadata.rewardPerImpression

boolean | null

Flag indicating if rewards are given per impression.

Example:

true

metadata.minQty

number | null

Minimum quantity constraint for token holding.

Example:

1

metadata.maxQty

number | null

Maximum quantity constraint for token holding.

Example:

10

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.

Example:

false

metadata.isTokenHoldMultiplier

boolean

default:true

Flag indicating if the token hold multiplier is applied.

Example:

true

metadata.saleCurrency

string

Currency associated with sales.

Example:

"USD"

metadata.isRetroactive

boolean | null

Flag indicating if rewards are applied retroactively.

Example:

true

metadata.timeDelayToVerifySeconds

Time delay in seconds to verify actions.

Example:

300

metadata.referralRequirements

object | null

Object defining referral requirements.

metadata.multiplierLoyaltyCurrencyIds

string[] | null

Array of loyalty currency IDs used for multipliers.

Example:

["currency123", "currency456"]

metadata.verifyPlaceHolderText

string | null

Placeholder text for verification input fields.

Example:

"Enter your verification code here."

metadata.verificationTextMinimumLength

integer | null

Minimum length of the verification text.

Example:

10

metadata.buttonText

string | null

Text displayed on the action button.

Example:

"Verify Now"

metadata.telegramChannelId

string | null

ID of the Telegram channel.

Example:

"telegram-channel-123"

metadata.twitterAccountUrl

string

URL of the associated Twitter account.

Example:

"https://twitter.com/example_user"

metadata.twitterPostUrl

string

URL of the associated Twitter post.

Example:

"https://twitter.com/example/status/1234567890"

metadata.checkLike

boolean | null

Flag indicating if liking the post is required.

Example:

true

metadata.checkRepost

boolean | null

Flag indicating if reposting is required.

Example:

true

metadata.checkComment

boolean | null

Flag indicating if commenting is required.

Example:

true

metadata.checkText

string | null

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

Example:

"loyalty"

metadata.smartContract

object

Object containing details of the associated smart contract.

metadata.smartContract.contractId

string | null

ID of the smart contract.

Example:

"123e4567-e89b-12d3-a456-426614174000"

metadata.smartContract.abi

string | null

ABI of the smart contract.

Example:

"[]"

metadata.smartContract.event

string | null

Event emitted by the smart contract.

Example:

"Transfer"

metadata.smartContract.criteria

enum<string> | null

Criteria to evaluate the smart contract event.

Available options:

everyEvent,

byParameter

Example:

"everyEvent"

metadata.smartContract.params

object[] | null

Array of parameters for the smart contract.

metadata.smartContract.withCustomRange

boolean | null

Flag indicating if a custom range is applied.

Example:

true

metadata.smartContract.customRange

object | null

Time range applied to the rule.

metadata.smartContract.withMax

boolean | null

Flag indicating if a maximum limit is applied.

Example:

true

metadata.smartContract.max

number | null

Maximum value allowed for the parameter.

Example:

1000

metadata.smartContract.withBonus

boolean | null

Flag indicating if a bonus is applied.

Example:

true

metadata.smartContract.bonus

object[] | null

Array of bonus details applied to the rule.

metadata.smartContract.addressMapping

string | null

Mapping of addresses for the smart contract.

Example:

"0x123...789"

metadata.walletType

enum<string> | null

Type of wallet associated with the rule.

Available options:

evm,

solana,

imx,

sui,

ton

Example:

"evm"

metadata.imageUrl

string | null

URL of the image associated with the rule.

Example:

"https://example.com/image.png"

metadata.trackAllContracts

boolean | null

Flag indicating if all contracts are tracked.

Example:

true

metadata.onlyRewardSingleTokenOwnership

boolean | null

give points for only one token ownership per contract

Example:

true

metadata.skipMultiplier

boolean | null

Flag indicating if the multiplier is skipped.

Example:

true

metadata.completeProfileConditions

object | null

Conditions for completing the profile.

Example:

{ "twitter": true, "discord": false }

loyaltyCurrencyId

string

required

Unique identifier for the loyalty currency

Example:

"456e1234-e89b-12d3-a456-426614174003"

backgroundAssetUrl

string

URL of the background asset to be displayed

Example:

"https://example.com/background.png"

description

string

Optional detailed description of the rule

Example:

"A loyalty rule rewarding users for referrals."

network

enum<string>

default:mainnet

Blockchain network where the rule will apply

Available options:

abstract,

abstractTestnet,

apechain,

arbitrum,

avalanche,

avalancheFuji,

base,

baseSepolia,

berachainArtio,

binance,

bscTestnet,

campTestnet,

fantom,

fantomTestnet,

flowMainnet,

mainnet,

optimism,

polygon,

polygon_mumbai,

skaleNebula,

solana,

sophon,

sui,

superseed,

superseedSepolia,

vanar,

xai,

zksync,

sepolia,

optimism_sepolia,

arbitrumSepolia,

goerli,

optimism_goerli,

arbitrumGoerli,

basecamp

Example:

"mainnet"

interval

enum<string> | null

Interval between rule executions

Available options:

daily,

weekly,

monthly,

once,

custom,

every_message

Example:

"weekly"

customRewardsCsvUrl

string | null

URL for uploading custom rewards via CSV

Example:

"https://example.com/rewards.csv"

customRewardsApiUrl

string | null

URL for fetching custom rewards

Example:

"https://api.example.com/rewards"

subscriptionIdentifier

string | null

Identifier for associated subscriptions

Example:

"sub12345"

collectionAddress

string

Blockchain address of the associated collection

Example:

"0x1234567890abcdef1234567890abcdef12345678"

collections

object[] | null

List of associated collections

hideInUi

boolean

default:false

Whether to hide this rule in the user interface

Example:

false

isRequired

boolean

default:false

Whether this rule is mandatory

Example:

true

oauthCredentialsId

string | null

OAuth credentials associated with the rule

Example:

"123e4567-e89b-12d3-a456-426614174003"

loyaltyRuleGroupId

Unique identifier for the loyalty rule group

Available options:

no-section

Example:

"123e4567-e89b-12d3-a456-426614174004"

rewardType

enum<string>

default:points

Type of reward issued by the rule

Available options:

points,

multiplier

Example:

"points"

mediaUrl

string | null

URL of the media to be displayed

Example:

"https://example.com/media.png"

Response

200

application/json

200

Schema for creating a new loyalty rule with detailed validations

string

required

organizationId

string

required

Unique identifier for the organization creating the rule

Example:

"123e4567-e89b-12d3-a456-426614174001"

websiteId

string

required

Unique identifier for the associated website

Example:

"123e4567-e89b-12d3-a456-426614174002"

name

string

required

Name of the loyalty rule

Minimum length: 1

Example:

"Referral Bonus Rule"

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,

check_in,

code_entry,

connect_wallet,

connected_discord,

connected_email,

connected_epic,

connected_steam,

connected_telegram,

connected_twitter,

create_partner_account,

discord_member,

drip_x_follow,

drip_x_new_tweet,

drip_x_text_in_bio,

drip_x_text_in_comment,

drip_x_text_in_name,

drip_x_tweet,

external_rule,

link_click,

manual_upload,

profile_completed,

referred_user,

smart_contract_event,

snapshot_governance,

telegram_join,

telegram_messages,

text_input,

token_hold_erc20,

tweet_liked_by_project,

twitter_comment,

twitter_follow,

twitter_followers,

twitter_like,

twitter_post_hashtag,

quiz,

poll

Example:

"Bonus"

frequency

enum<string>

required

Execution frequency of the loyalty rule

Available options:

none,

once,

daily,

weekly,

monthly,

immediately

Example:

"daily"

startTime

string | null

required

When the rule becomes active

Example:

"2024-01-01T00:00:00Z"

endTime

string | null

required

When the rule becomes inactive

Example:

"2024-12-31T23:59:00Z"

effectiveStartTime

required

The effective start time of the rule

Example:

"2024-01-01T00:00:00Z"

effectiveEndTime

required

The effective end time of the rule

Example:

"2024-12-31T23:59:00Z"

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.

Example:

true

metadata.hasPaidFullRoyalty

boolean

Indicates if the full royalty has been paid for items.

Example:

false

metadata.hasVerifiedTwitter

boolean

Indicates if the user has a verified Twitter account.

Example:

true

metadata.onlyRewardExistingUser

boolean

Indicates if only existing users are rewarded.

Example:

true

metadata.hasNeverSold

boolean

Indicates if the item has never been sold.

Example:

false

metadata.onlyNative

boolean

Flag indicating whether to include only native tokens.

Example:

true

metadata.hasFillSource

boolean

Flag indicating whether the fill source is included.

Example:

true

metadata.fillSource

string

Fill source of the order for the token sale

Example:

"opensea.io"

metadata.hasOrderSource

boolean

Flag indicating whether the order source is included.

Example:

true

metadata.orderSource

string

Order source of the order for the token sale

Example:

"opensea.io"

metadata.twitterUsername

string

Twitter username of the user.

Example:

"@example_user"

metadata.twitterUserId

string

Unique identifier of the Twitter user.

Example:

"1234567890"

metadata.twitterHashtag

string

Hashtag associated with the Twitter post.

Example:

"#loyalty"

metadata.enableVerifiedMultiplier

boolean

Flag indicating whether the verified multiplier is enabled.

Example:

true

metadata.verifiedMultiplier

number | null

Multiplier applied to rewards for verified users.

Example:

1.5

metadata.isMultiplierApplied

boolean

Indicates if the multiplier has been applied to rewards.

Example:

true

metadata.onlyKnownUsers

boolean

Flag indicating whether to include only known users.

Example:

false

metadata.firstReferralReward

number | null

Percentage reward given to a user for their first referral.

Example:

10

metadata.referrerReward

number | null

Lump sum reward given to a referrer.

Example:

50

metadata.secondReferralReward

number | null

Percentage reward given for a second-level referral.

Example:

5

metadata.enableStreaks

boolean | null

Flag indicating whether streaks are enabled.

Example:

true

Promotional code associated with the rule.

Example:

"PROMO123"

metadata.enableJoinDiscordServers

boolean | null

Flag indicating whether joining Discord servers is required.

Example:

true

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.

Example:

"api-key-1234"

metadata.link

string | null

Optional link associated with the metadata.

Example:

"https://example.com"

Social media platform associated with the rule.

Available options:

Custom,

Discord,

EpicGames,

Instagram,

Steam,

Telegram,

TikTok,

Twitch,

X(Twitter),

YouTube

Example:

"X(Twitter)"

Name of the social platform.

Example:

"Twitter"

URL of the social platform's logo.

Example:

"https://example.com/logo.png"

metadata.rewardPerImpression

boolean | null

Flag indicating if rewards are given per impression.

Example:

true

metadata.minQty

number | null

Minimum quantity constraint for token holding.

Example:

1

metadata.maxQty

number | null

Maximum quantity constraint for token holding.

Example:

10

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.

Example:

false

metadata.isTokenHoldMultiplier

boolean

default:true

Flag indicating if the token hold multiplier is applied.

Example:

true

metadata.saleCurrency

string

Currency associated with sales.

Example:

"USD"

metadata.isRetroactive

boolean | null

Flag indicating if rewards are applied retroactively.

Example:

true

metadata.timeDelayToVerifySeconds

number

Time delay in seconds to verify actions.

Example:

300

metadata.referralRequirements

object | null

Object defining referral requirements.

metadata.multiplierLoyaltyCurrencyIds

string[] | null

Array of loyalty currency IDs used for multipliers.

Example:

["currency123", "currency456"]

metadata.verifyPlaceHolderText

string | null

Placeholder text for verification input fields.

Example:

"Enter your verification code here."

metadata.verificationTextMinimumLength

integer | null

Minimum length of the verification text.

Example:

10

metadata.buttonText

string | null

Text displayed on the action button.

Example:

"Verify Now"

metadata.telegramChannelId

string | null

ID of the Telegram channel.

Example:

"telegram-channel-123"

metadata.twitterAccountUrl

string

URL of the associated Twitter account.

Example:

"https://twitter.com/example_user"

metadata.twitterPostUrl

string

URL of the associated Twitter post.

Example:

"https://twitter.com/example/status/1234567890"

metadata.checkLike

boolean | null

Flag indicating if liking the post is required.

Example:

true

metadata.checkRepost

boolean | null

Flag indicating if reposting is required.

Example:

true

metadata.checkComment

boolean | null

Flag indicating if commenting is required.

Example:

true

metadata.checkText

string | null

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

Example:

"loyalty"

metadata.smartContract

object

Object containing details of the associated smart contract.

metadata.smartContract.contractId

string | null

ID of the smart contract.

Example:

"123e4567-e89b-12d3-a456-426614174000"

metadata.smartContract.abi

string | null

ABI of the smart contract.

Example:

"[]"

metadata.smartContract.event

string | null

Event emitted by the smart contract.

Example:

"Transfer"

metadata.smartContract.criteria

enum<string> | null

Criteria to evaluate the smart contract event.

Available options:

everyEvent,

byParameter

Example:

"everyEvent"

metadata.smartContract.params

object[] | null

Array of parameters for the smart contract.

metadata.smartContract.withCustomRange

boolean | null

Flag indicating if a custom range is applied.

Example:

true

metadata.smartContract.customRange

object | null

Time range applied to the rule.

metadata.smartContract.withMax

boolean | null

Flag indicating if a maximum limit is applied.

Example:

true

metadata.smartContract.max

number | null

Maximum value allowed for the parameter.

Example:

1000

metadata.smartContract.withBonus

boolean | null

Flag indicating if a bonus is applied.

Example:

true

metadata.smartContract.bonus

object[] | null

Array of bonus details applied to the rule.

metadata.smartContract.addressMapping

string | null

Mapping of addresses for the smart contract.

Example:

"0x123...789"

metadata.walletType

enum<string> | null

Type of wallet associated with the rule.

Available options:

evm,

solana,

imx,

sui,

ton

Example:

"evm"

metadata.imageUrl

string | null

URL of the image associated with the rule.

Example:

"https://example.com/image.png"

metadata.trackAllContracts

boolean | null

Flag indicating if all contracts are tracked.

Example:

true

metadata.onlyRewardSingleTokenOwnership

boolean | null

give points for only one token ownership per contract

Example:

true

metadata.skipMultiplier

boolean | null

Flag indicating if the multiplier is skipped.

Example:

true

metadata.completeProfileConditions

object | null

Conditions for completing the profile.

Example:

{ "twitter": true, "discord": false }

loyaltyCurrencyId

string

required

Unique identifier for the loyalty currency

Example:

"456e1234-e89b-12d3-a456-426614174003"

backgroundAssetUrl

string

URL of the background asset to be displayed

Example:

"https://example.com/background.png"

description

string

Optional detailed description of the rule

Example:

"A loyalty rule rewarding users for referrals."

network

enum<string>

default:mainnet

Blockchain network where the rule will apply

Available options:

abstract,

abstractTestnet,

apechain,

arbitrum,

avalanche,

avalancheFuji,

base,

baseSepolia,

berachainArtio,

binance,

bscTestnet,

campTestnet,

fantom,

fantomTestnet,

flowMainnet,

mainnet,

optimism,

polygon,

polygon_mumbai,

skaleNebula,

solana,

sophon,

sui,

superseed,

superseedSepolia,

vanar,

xai,

zksync,

sepolia,

optimism_sepolia,

arbitrumSepolia,

goerli,

optimism_goerli,

arbitrumGoerli,

basecamp

Example:

"mainnet"

interval

enum<string> | null

Interval between rule executions

Available options:

daily,

weekly,

monthly,

once,

custom,

every_message

Example:

"weekly"

customRewardsCsvUrl

string | null

URL for uploading custom rewards via CSV

Example:

"https://example.com/rewards.csv"

customRewardsApiUrl

string | null

URL for fetching custom rewards

Example:

"https://api.example.com/rewards"

subscriptionIdentifier

string | null

Identifier for associated subscriptions

Example:

"sub12345"

collectionAddress

string

Blockchain address of the associated collection

Example:

"0x1234567890abcdef1234567890abcdef12345678"

collections

object[] | null

List of associated collections

hideInUi

boolean

default:false

Whether to hide this rule in the user interface

Example:

false

isRequired

boolean

default:false

Whether this rule is mandatory

Example:

true

oauthCredentialsId

string | null

OAuth credentials associated with the rule

Example:

"123e4567-e89b-12d3-a456-426614174003"

loyaltyRuleGroupId

Unique identifier for the loyalty rule group

Available options:

no-section

Example:

"123e4567-e89b-12d3-a456-426614174004"

rewardType

enum<string>

default:points

Type of reward issued by the rule

Available options:

points,

multiplier

Example:

"points"

mediaUrl

string | null

URL of the media to be displayed

Example:

"https://example.com/media.png"

Was this page helpful?

Get Loyalty Rules Update Loyalty Rule

import SnagSolutions from '@snagsolutions/sdk';

const client = new SnagSolutions({
  apiKey: process.env['X_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const rule = await client.loyalty.rules.create({
    amount: '10.5',
    effectiveEndTime: '2024-12-31T23:59:00Z',
    effectiveStartTime: '2024-01-01T00:00:00Z',
    endTime: '2024-12-31T23:59:00Z',
    frequency: 'none',
    loyaltyCurrencyId: '456e1234-e89b-12d3-a456-426614174003',
    metadata: {},
    name: 'Referral Bonus Rule',
    organizationId: '123e4567-e89b-12d3-a456-426614174001',
    startTime: '2024-01-01T00:00:00Z',
    type: 'Bonus',
    websiteId: '123e4567-e89b-12d3-a456-426614174002',
  });

  console.log(rule.id);
}

main();

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "123e4567-e89b-12d3-a456-426614174001",
  "websiteId": "123e4567-e89b-12d3-a456-426614174002",
  "backgroundAssetUrl": "https://example.com/background.png",
  "name": "Referral Bonus Rule",
  "description": "A loyalty rule rewarding users for referrals.",
  "network": "mainnet",
  "type": "Bonus",
  "frequency": "daily",
  "interval": "weekly",
  "startTime": "2024-01-01T00:00:00Z",
  "endTime": "2024-12-31T23:59:00Z",
  "effectiveStartTime": "2024-01-01T00:00:00Z",
  "effectiveEndTime": "2024-12-31T23:59:00Z",
  "amount": "<any>",
  "customRewardsCsvUrl": "https://example.com/rewards.csv",
  "customRewardsApiUrl": "https://api.example.com/rewards",
  "subscriptionIdentifier": "sub12345",
  "metadata": {
    "onlyNonListed": true,
    "hasPaidFullRoyalty": false,
    "hasVerifiedTwitter": true,
    "onlyRewardExistingUser": true,
    "hasNeverSold": false,
    "onlyNative": true,
    "hasFillSource": true,
    "fillSource": "opensea.io",
    "hasOrderSource": true,
    "orderSource": "opensea.io",
    "twitterUsername": "@example_user",
    "twitterUserId": "1234567890",
    "twitterHashtag": "#loyalty",
    "enableVerifiedMultiplier": true,
    "verifiedMultiplier": 1.5,
    "isMultiplierApplied": true,
    "onlyKnownUsers": false,
    "firstReferralReward": 10,
    "referrerReward": 50,
    "secondReferralReward": 5,
    "enableStreaks": true,
    "promoCode": "PROMO123",
    "enableJoinDiscordServers": true,
    "discordServersToJoin": [
      {
        "id": "123456789012345678",
        "channels": [
          {
            "id": "987654321098765432",
            "text": "Hello",
            "emojis": [
              {
                "id": "1f600"
              }
            ]
          }
        ],
        "roles": [
          {
            "id": "role123"
          }
        ]
      }
    ],
    "streakArray": [
      {
        "streakMilestone": 5,
        "streakAmount": 10
      }
    ],
    "dripQuestsToComplete": [
      {
        "id": "drip123"
      }
    ],
    "collection": [
      {
        "address": "0xabcdefabcdefabcdefabcdefabcdefabcdef",
        "network": "mainnet",
        "multiplier": 2
      }
    ],
    "range": [
      {
        "startRange": 1,
        "endRange": 10,
        "amount": 5
      }
    ],
    "customRewardsApiKey": "api-key-1234",
    "link": "https://example.com",
    "socialPlatform": "X(Twitter)",
    "socialPlatformName": "Twitter",
    "socialPlatformLogo": "https://example.com/logo.png",
    "rewardPerImpression": true,
    "minQty": 1,
    "maxQty": 10,
    "snapshotProposals": [
      {
        "id": "proposal123",
        "space": "space123"
      }
    ],
    "cta": {
      "label": "Click Here",
      "href": "https://example.com"
    },
    "hasSaleCurrency": false,
    "isTokenHoldMultiplier": true,
    "saleCurrency": "USD",
    "isRetroactive": true,
    "timeDelayToVerifySeconds": 300,
    "referralRequirements": {
      "points": {
        "amount": 50,
        "loyaltyCurrecyId": "currency123"
      },
      "achievePoints": true,
      "completeProfile": false,
      "connectTwitter": true,
      "connectDiscord": true,
      "connectEmail": true
    },
    "multiplierLoyaltyCurrencyIds": [
      "currency123",
      "currency456"
    ],
    "verifyPlaceHolderText": "Enter your verification code here.",
    "verificationTextMinimumLength": 10,
    "buttonText": "Verify Now",
    "telegramChannelId": "telegram-channel-123",
    "twitterAccountUrl": "https://twitter.com/example_user",
    "twitterPostUrl": "https://twitter.com/example/status/1234567890",
    "checkLike": true,
    "checkRepost": true,
    "checkComment": true,
    "checkText": "loyalty",
    "smartContract": {
      "contractId": "123e4567-e89b-12d3-a456-426614174000",
      "abi": "[]",
      "event": "Transfer",
      "criteria": "everyEvent",
      "params": [
        {
          "name": "value",
          "condition": ">=",
          "value": "100"
        }
      ],
      "withCustomRange": true,
      "customRange": {
        "startsAt": "2024-01-01T00:00:00Z",
        "endsAt": "2024-01-31T23:59:59Z"
      },
      "withMax": true,
      "max": 1000,
      "withBonus": true,
      "bonus": [
        {
          "amount": 50,
          "count": 5
        }
      ],
      "addressMapping": "0x123...789"
    },
    "walletType": "evm",
    "imageUrl": "https://example.com/image.png",
    "trackAllContracts": true,
    "onlyRewardSingleTokenOwnership": true,
    "skipMultiplier": true,
    "completeProfileConditions": {
      "twitter": true,
      "discord": false
    }
  },
  "collectionAddress": "0x1234567890abcdef1234567890abcdef12345678",
  "collections": [
    {
      "address": "0xabcdefabcdefabcdefabcdefabcdefabcdef",
      "network": "mainnet"
    }
  ],
  "hideInUi": false,
  "isRequired": true,
  "oauthCredentialsId": "123e4567-e89b-12d3-a456-426614174003",
  "loyaltyCurrencyId": "456e1234-e89b-12d3-a456-426614174003",
  "loyaltyRuleGroupId": "123e4567-e89b-12d3-a456-426614174004",
  "rewardType": "points",
  "mediaUrl": "https://example.com/media.png"
}

API Documentation

Asset

Auction

Identity

Loyalty

Badge

Minting

Question

Referrals

Website

Create Loyalty Rule

Authorizations

Body

Response