POST
/
api
/
loyalty
/
rules
/
{id}

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

Body

application/json
amount
any | null
required

Reward amount for the loyalty rule

effectiveEndTime
required

Effective end time of the rule

effectiveStartTime
required

Effective start time of the rule

endTime
string | null
required

End time for the loyalty rule

frequency
enum<string>
required

Frequency of the rule execution

Available options:
none,
once,
daily,
weekly,
monthly,
immediately
metadata
object
required

Additional metadata for the loyalty rule

name
string
required

Name of the loyalty rule

Minimum length: 1
startTime
string | null
required

Start time for the loyalty rule

collectionAddress
string

Blockchain address of the associated collection

collections
object[] | null

List of associated collections

customRewardsApiUrl
string | null

API URL for custom rewards integration

customRewardsCsvUrl
string | null

URL for uploading custom rewards via CSV

description
string

Optional description of the loyalty rule

hideInUi
boolean
default:
false

Whether to hide this rule in the user interface

interval
enum<string> | null

Time interval for recurring rule execution

Available options:
daily,
weekly,
monthly,
once
isRequired
boolean
default:
false

Whether this rule is required for participation

loyaltyRuleGroupId

ID of the rule group section to associate with 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
oauthCredentialsId
string | null

ID for associated OAuth credentials

rewardType
enum<string>
default:
points

Type of reward issued by this rule

Available options:
points,
multiplier
subscriptionIdentifier
string | null

Optional subscription identifier for the rule

Response

200 - application/json
amount
any | null
required

Reward amount for the loyalty rule

effectiveEndTime
required

Effective end time of the rule

effectiveStartTime
required

Effective start time of the rule

endTime
string | null
required

End time for the loyalty rule

frequency
enum<string>
required

Frequency of the rule execution

Available options:
none,
once,
daily,
weekly,
monthly,
immediately
id
string
required
metadata
object
required

Additional metadata for the loyalty rule

name
string
required

Name of the loyalty rule

Minimum length: 1
startTime
string | null
required

Start time for the loyalty rule

collectionAddress
string

Blockchain address of the associated collection

collections
object[] | null

List of associated collections

customRewardsApiUrl
string | null

API URL for custom rewards integration

customRewardsCsvUrl
string | null

URL for uploading custom rewards via CSV

description
string

Optional description of the loyalty rule

hideInUi
boolean
default:
false

Whether to hide this rule in the user interface

interval
enum<string> | null

Time interval for recurring rule execution

Available options:
daily,
weekly,
monthly,
once
isRequired
boolean
default:
false

Whether this rule is required for participation

loyaltyRuleGroupId

ID of the rule group section to associate with 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
oauthCredentialsId
string | null

ID for associated OAuth credentials

rewardType
enum<string>
default:
points

Type of reward issued by this rule

Available options:
points,
multiplier
subscriptionIdentifier
string | null

Optional subscription identifier for the rule