Jump to Content
Guides
API Endpoints
Changelog
Home
Guides
API Endpoints
Changelog
Guides
API Endpoints
Changelog
Log In
API Endpoints
Log In
API Endpoints
Leaderboard Views
All
Pages
Start typing to search…
JUMP TO
Engagement Suite
Introduction
Errors
Authentication
Pagination
Localization
Profiles
Using Profiles
Create User Profile
post
Create Profile by Custom ID
post
Get User Profile
get
Get Profile by Custom ID
get
Update User Profile
patch
Prizeout User Session
post
Delete User Profile
del
Profile Relationships
List Relationship Types
get
Create a Relationship Type
post
Create a Profile Relationship
post
Delete a Profile Relationship
del
List Profile Relationships
get
Programs
Using Programs
Get Program
get
Get Program by Custom ID
get
Create Program
post
List Programs
get
Update Program
patch
Chat Rooms
Using Chat Rooms
Get a Chat Room
get
Get List of Chat Room
get
Create a Chat Room
post
Update a Chat Room
patch
Delete a Chat Room
del
Delete A Chat Room Message
post
Link a chat room with a program
put
Unlink a chat room from a program
del
Send a Chat Message
post
Send a Custom Chat Message
post
List Chat Messages
get
Get Chat Message Count
get
Get Reported Chat Messages
get
Using Message Threads
Pin Message
Create a pin message
post
Get Pinned Message Info
get
Unpin Message
del
Chat Room Memberships
List Chat Room Memberships
get
List a User's Chat Room Memberships
get
Create a Chat Room Membership
post
Delete a Chat Room Membership
del
Chat Room Invitations
List Chat Room Invitations
get
Create a Chat Room Invitation
post
Update a Chat Room Invitation
patch
Delete a Chat Room Invitation
del
Chatroom Access Rule
Create an access rule for mute/globally mute
post
Remove a chatroom access rule
del
Stickers
Create a Sticker
post
Create a Sticker Pack
post
List Profile Exclusive Sticker Packs
get
Revoke Profile Sticker Pack
del
Assign Exclusive Sticker Pack to Profile
post
Flairs
Flair
Create A Flair
post
List Flairs
get
Flair Detail
get
Update A Flair
patch
Delete A Flair
del
Flair Scope
Create a Flair Scope
post
List Flair Scopes
get
Flair Scope Detail
get
Update A Flair Scope
patch
Flair Assignment
Create A Flair Assignment
post
List Flair Assignments
get
Flair Assignment Detail
get
Update a Flair Assignment
patch
Delete A Flair Assignment
del
Widgets
Using Widgets
Listing Widgets
Widget Analytics
Get Widget Interactions
get
Get Unclaimed Widget Interactions
get
Widget Impressions
Publish Widget
put
Delete Widget
del
Report a widget
post
Moderate a widget report
patch
List widget reports
get
Alerts
Get an Alert
get
Create an Alert
post
Video Alerts
Get a Video Alert
get
Create a Video Alert
post
Update a Video Alert
patch
Delete a Video Alert
del
Polls
Get a Text Poll
get
Create Text Poll
post
Get an Image Poll
get
Create Image Poll
post
Create a Poll Vote
post
Emoji Sliders
Create an Emoji Slider
post
Get an Emoji Slider
get
Cheer-Meters
Create a Cheer Meter
post
Quizzes
Create a Text Quiz
post
Create an Image Quiz
post
Get a Text Quiz
get
Get an Image Quiz
get
Image Predictions
Using Predictions
Get Image Prediction
get
Create Image Prediction
post
Create Image Prediction Follow-up
post
Update Text Prediction Option
patch
Update Image Prediction Option
patch
Create Image Prediction Option
post
Text Prediction
Create Text Prediction
post
Get Text Prediction
get
Update Text Prediction
patch
Create Text Prediction Follow-up
post
Create Text Prediction Option
post
Number Predictions
Create an Image Number Prediction
post
Update Image Number Prediction Option
patch
Create Image Number Prediction Follow-up
post
Update Image Number Prediction
patch
Get Image Number Prediction
get
Create Image Number Prediction Option
post
Text Ask
Create a Text Ask widget
post
Get a Text Ask Widget
get
Social Embeds
Create a Social Embed
post
Get a Social Embed
get
Rich Posts
Create a Rich Post
post
Get a Rich Post
get
List Rich Posts
get
Leaderboards
Get Leaderboard Details
get
Get Leaderboard Details by Custom Id
get
List Leaderboards
get
Create Leaderboard
post
Update a Leaderboard
patch
Update a Leaderboard by custom-id
patch
List Leaderboard Entries
get
Get Leaderboard Entry Detail
get
Link a Leaderboard with a Program
put
Unlink a leaderboard from a program
del
Leaderboard Views
List Views for a Leaderboard
get
Create a Leaderboard View
post
Replace Profiles in a View
put
Add Profiles to a Leaderboard View
patch
Delete a Leaderboard View
del
Delete a Profile from a Leaderboard View
del
List Profiles for a Leaderboard View
get
List all leaderboard views in a Leaderboard
get
Rewards
List Reward Items
get
Create Reward Item
post
Get reward item balance
get
List Reward Item Balances
get
Credit Reward Item
post
Debit Reward Item
post
Transfer Reward Items
post
List Reward Transactions
get
List Reward Item Transfers
get
Get Reward Table
get
List Reward Tables
get
List Reward Actions
get
Create Reward Table
post
Delete Reward Table
del
Create Reward Table Entry
post
Get Reward Table Entry
get
Delete Reward Table Entry
del
Link a reward table with a program
put
Unlink a reward table with a program
del
Create Reward Action
post
List Invoked Reward Actions
get
Invoke Reward Action
post
Batch Invoke Reward Action
post
Badges
List App Badges
get
Create App Badge
post
Get an App Badge
get
List Earned Badges
get
Award a Badge to a User
post
List Badge progress
get
List Profiles who have earned a specific badge
get
Get List of earned badges
get
Revoke Earned Badge
del
Sponsors
List Application Sponsors
get
Assets
List Assets
get
Get an Asset
get
Block Profile
Block a Profile
post
Get blocked profiles
get
Unblock profile by Block Object ID
del
Unblock profile by Profile ID
del
Unblock profile by Profile Custom ID
del
Get Blocked Profile Ids
get
Bulk Block Sync
post
Applications
Get an Application
get
Create an Application
post
Update an Application
patch
Delete an application
del
Redemption Keys
Get a Redemption Key
get
List Redemption Keys
get
Create a Redemption Key
post
Update a Redemption Key
patch
Update a Redemption Key by Code
patch
Delete a Redemption Key
del
Registered Links
Create a Registered Link
post
List Registered Links
get
Delete a Registered Link
del
Quests
Create Quest
post
Get Quest
get
List Quests
get
Delete Quest
del
Create Task
post
Get Task
get
Delete Task
del
List Tasks
get
List User Quests
get
Create User Quest
post
Update User Quest Task Progress
post
Delete UserQuest
del
Update User Quest
patch
Create Quest Rewards
post
Remove a quest reward
del
Get list of quest rewards
get
Get user quest rewards
get
Claim user quest rewards
patch
Get Quest Badges
get
Add Badges to Quest
post
Remove Badge from Quest
del
Claim User Quest Badge
patch
A/B Test Quest
Create AB Test Quest
post
Get AB Test Quest
get
List AB Test Quests
get
Assign Quest Variant to Profile
put
REACTION pACKS
Create a Reaction Pack
post
Add a Reaction emoji to a pack
post
Update a Reaction emoji
patch
Delete a Reaction Emoji
del
List Reaction Packs
get
Delete a Reaction pack
del
List Profile Exclusive Reaction Packs
get
Assign Exclusive Reaction Pack to Profile
post
Revoke Profile Reaction Pack
del
Reaction Spaces
Get a Reaction Space
get
Create Reaction Space
post
List Reaction Spaces
get
Update a Reaction Space
patch
Delete a Reaction Space
del
User Reaction
Create a user reaction
post
List user reactions
get
Delete a user reaction
del
Get user reaction count
get
Comment
Create a Comment
post
List comments
get
List Comments by Author
get
Update a comment
patch
Delete a comment
del
List Replies to Profile's Comments
get
Get comment counts
get
Comment Board
Create a Comment Board
post
Get the list of comment boards
get
Update a comment board
patch
Delete Comment Board
del
Get comment board by custom_id
get
Update Comment Board by custom id
patch
Delete comment board by custom id
del
Comments Bans
Banning Users from Comment Boards
Create a comment board ban
post
Get list of comment board bans
get
Remove a ban from a comment board
del
Get comment board ban detail
get
Role Based access control
Role Based Access Control
Using RBAC
Get List of Resources
get
Get List of Permissions
get
Get Role Templates
get
Create a Base Role
post
Get List of Base Roles
get
Patch Update a Base Role
patch
Put Update a Base Role
put
Delete a Base Role
del
Create a Role
post
Get List of Roles
get
Patch Update a Role
patch
Put Update a Role
put
Delete a Role
del
Create Role Assignments
post
Delete Role Assignment
del
Get List of Scopes
get
List Role assignments
get
Profile permissions check
get
Comment Reports
Create Comment Report
post
Get List of comment reports
get
Dismiss a comment report
patch
Cancel a comment report
del
Dismiss all reports for a reported comment
patch
Football Live Action
Create Live Action
post
Update Live Action
patch
Get Live Action
get
Delete Live Action
del
Football Live Match Actions
Create Match Action
post
Update Match Action
patch
Get Match Action
get
Delete Match Action
del
Match Insights Alerts
Create Match Insights
post
Get Match Insights
get
Delete Match Insights
del
WILDMOKA VIDEO ALERTS
Create Wildmoka Video Alerts
post
Get Wildmoka Video Alerts
get
Update Wildmoka Video Alerts
patch
Delete Wildmoka Video Alerts
del
Program bans
Program Bans
Create a Program Ban
post
Get Program Bans
get
Delete a Program Ban
del
Pinned Comments
Pinning a comment
post
Unpin a pinned comment
del
List Pinned Comments
get
Status Tiers
Using Status Tiers
Create Tier Group
post
List Tier Groups
get
Update Tier Group
patch
Delete a Tier Group
del
Create Tier
post
List Tiers
get
Retrieve a Tier
get
Update Tier
patch
Delete Tier
del
Create Tier Benefit
post
List Tier Benefits
get
Retrieve Tier Benefit
get
Update Tier Benefit
patch
Delete Tier Benefit
del
Assigning tier to a profile
List Tier Transactions
get
List User Tiers
get
Assign tier to a profile
put
Streak
Periodic Streaks
Create a Periodic Streak
post
Publish Periodic Streak
post
List Periodic Streaks
get
Get periodic streak detail
get
Unarchive a periodic streak
post
Archive a periodic streak
post
Update a periodic streak
patch
Delete Periodic Streak
del
Consecutive Streaks
Get consecutive action streak detail
get
List Consecutive Action Streaks
get
Publish Consecutive Action Streak
post
Create a Consecutive Action Streak
post
Update a consecutive action streak
patch
Create Streak Targets
post
Update Streak Target
patch
Delete streak target
del
List Streak Targets
get
Create Streak Target with CSV
post
Archive a consecutive action streak
post
Unarchive a consecutive action streak
post
Delete a consecutive action streak
del
User Streaks
List User Streaks
get
Create user streak
post
Progress active User Streak
patch
List User Streak Milestones
get
Reset User Streak
post
Streak Milestone
Delete streak milestone
del
Update Streak Milestone
patch
Create Streak Milestone
post
List Streak Milestones
get
Rewards Store
Reward Store API documentation
Powered by
Leaderboard Views
Ask AI
Group and query for only a subset of Profile entries on a large Leaderboard.
