Jump to Content

Guides API Endpoints Changelog

Home Guides API Endpoints Changelog

Guides API Endpoints Changelog Log In

API Endpoints

All

Pages

Start typing to search…

Engagement Suite

Introduction
Errors
Authentication
Pagination
Localization

Profiles

Using Profiles
Create User Profilepost
Create Profile by Custom IDpost
Get User Profileget
Get Profile by Custom IDget
Update User Profilepatch
Prizeout User Sessionpost
Delete User Profiledel
Profile Relationships

Programs

Using Programs
Get Programget
Get Program by Custom IDget
Create Programpost
List Programsget
Update Programpatch

Chat Rooms

Using Chat Rooms
Get a Chat Roomget
Get List of Chat Roomget
Create a Chat Roompost
Update a Chat Roompatch
Delete a Chat Roomdel
Delete A Chat Room Messagepost
Link a chat room with a programput
Unlink a chat room from a programdel
Send a Chat Messagepost
Send a Custom Chat Messagepost
List Chat Messagesget
Get Chat Message Countget
Get Reported Chat Messagesget
Using Message Threads

Pin Message

Create a pin messagepost
Get Pinned Message Infoget
Unpin Messagedel

Chat Room Memberships

List Chat Room Membershipsget
List a User's Chat Room Membershipsget
Create a Chat Room Membershippost
Delete a Chat Room Membershipdel

Chat Room Invitations

List Chat Room Invitationsget
Create a Chat Room Invitationpost
Update a Chat Room Invitationpatch
Delete a Chat Room Invitationdel

Chatroom Access Rule

Create an access rule for mute/globally mutepost
Remove a chatroom access ruledel

Stickers

Create a Stickerpost
Create a Sticker Packpost

Widgets

Using Widgets
Listing Widgets
Widget Analytics
Get Widget Interactionsget
Get Unclaimed Widget Interactionsget
Widget Impressions
Publish Widgetput
Delete Widgetdel
Report a widgetpost
Moderate a widget reportpatch
List widget reportsget

Alerts

Get an Alertget
Create an Alertpost

Video Alerts

Get a Video Alertget
Create a Video Alertpost
Update a Video Alertpatch
Delete a Video Alertdel

Polls

Get a Text Pollget
Create Text Pollpost
Get an Image Pollget
Create Image Pollpost
Create a Poll Votepost

Emoji Sliders

Create an Emoji Sliderpost
Get an Emoji Sliderget

Cheer-Meters

Create a Cheer Meterpost

Quizzes

Create a Text Quizpost
Create an Image Quizpost
Get a Text Quizget
Get an Image Quizget

Image Predictions

Using Predictions
Get Image Predictionget
Create Image Predictionpost
Create Image Prediction Follow-uppost
Update Text Prediction Optionpatch
Update Image Prediction Optionpatch

Text Prediction

Create Text Predictionpost
Get Text Predictionget
Update Text Predictionpatch
Create Text Prediction Follow-uppost

Number Predictions

Create an Image Number Predictionpost
Update Image Number Prediction Optionpatch
Create Image Number Prediction Follow-uppost
Update Image Number Predictionpatch
Get Image Number Predictionget

Text Ask

Create a Text Ask widgetpost
Get a Text Ask Widgetget

Social Embeds

Create a Social Embedpost
Get a Social Embedget

Rich Posts

Create a Rich Postpost
Get a Rich Postget
List Rich Postsget

Leaderboards

Get Leaderboard Detailsget
Get Leaderboard Details by Custom Idget
List Leaderboardsget
Create Leaderboardpost
Update a Leaderboardpatch
Update a Leaderboard by custom-idpatch
List Leaderboard Entriesget
Get Leaderboard Entry Detailget
Link a Leaderboard with a Programput
Unlink a leaderboard from a programdel
Leaderboard Views

Rewards

List Reward Itemsget
Create Reward Itempost
Get reward item balanceget
List Reward Item Balancesget
Credit Reward Itempost
Debit Reward Itempost
Transfer Reward Itemspost
List Reward Transactionsget
List Reward Item Transfersget
Get Reward Tableget
List Reward Tablesget
List Reward Actionsget
Create Reward Tablepost
Delete Reward Tabledel
Create Reward Table Entrypost
Get Reward Table Entryget
Delete Reward Table Entrydel
Link a reward table with a programput
Unlink a reward table with a programdel
Create Reward Actionpost
List Invoked Reward Actionsget
Invoke Reward Actionpost
Batch Invoke Reward Actionpost

Badges

List App Badgesget
Create App Badgepost
Get an App Badgeget
List Earned Badgesget
Award a Badge to a Userpost
List Badge progressget
List Profiles who have earned a specific badgeget
Get List of earned badgesget
Revoke Earned Badgedel

Sponsors

List Application Sponsorsget

Assets

List Assetsget
Get an Assetget

Block Profile

Block a Profilepost
Get blocked profilesget
Unblock profiledel
Get Blocked Profile Idsget

Applications

Get an Applicationget
Create an Applicationpost
Update an Applicationpatch
Delete an applicationdel

Redemption Keys

Get a Redemption Keyget
List Redemption Keysget
Create a Redemption Keypost
Update a Redemption Keypatch
Update a Redemption Key by Codepatch
Delete a Redemption Keydel

Registered Links

Create a Registered Linkpost
List Registered Linksget
Delete a Registered Linkdel

Quests

Create Questpost
Get Questget
List Questsget
Delete Questdel
Create Taskpost
Get Taskget
Delete Taskdel
List Tasksget
List User Questsget
Create User Questpost
Update User Quest Task Progresspost
Delete UserQuestdel
Update User Questpatch
Create Quest Rewardspost
Remove a quest rewarddel
Get list of quest rewardsget
Get user quest rewardsget
Claim user quest rewardspatch
Get Quest Badgesget
Add Badges to Questpost
Remove Badge from Questdel
Claim User Quest Badgepatch

REACTION pACKS

Create a Reaction Packpost
Add a Reaction emoji to a packpost
Update a Reaction emojipatch
Delete a Reaction Emojidel
List Reaction Packsget
Delete a Reaction packdel

Reaction Spaces

Get a Reaction Spaceget
Create Reaction Spacepost
List Reaction Spacesget
Update a Reaction Spacepatch
Delete a Reaction Spacedel

User Reaction

Create a user reactionpost
List user reactionsget
Delete a user reactiondel
Get user reaction countget

Comment

Create a Commentpost
List commentsget
List Comments by Authorget
Update a commentpatch
Delete a commentdel
List Replies to Profile's Commentsget
Get comment countsget

Comment Board

Create a Comment Boardpost
Get the list of comment boardsget
Update a comment boardpatch
Delete Comment Boarddel
Get comment board by custom_idget
Update Comment Board by custom idpatch
Delete comment board by custom iddel

Comments Bans

Banning Users from Comment Boards

Role Based access control

Role Based Access Control
Using RBAC
Get List of Resourcesget
Get List of Permissionsget
Get Role Templatesget
Create a Base Rolepost
Get List of Base Rolesget
Patch Update a Base Rolepatch
Put Update a Base Roleput
Delete a Base Roledel
Create a Rolepost
Get List of Rolesget
Patch Update a Rolepatch
Put Update a Roleput
Delete a Roledel
Create Role Assignmentspost
Delete Role Assignmentdel

Comment Reports

Create Comment Reportpost
Get List of comment reportsget
Dismiss a comment reportpatch
Cancel a comment reportdel
Dismiss all reports for a reported commentpatch

Football Live Action

Create Live Actionpost
Update Live Actionpatch
Get Live Actionget
Delete Live Actiondel

Football Live Match Actions

Create Match Actionpost
Update Match Actionpatch
Get Match Actionget
Delete Match Actiondel

Match Insights Alerts

Create Match Insightspost
Get Match Insightsget
Delete Match Insightsdel

WILDMOKA VIDEO ALERTS

Create Wildmoka Video Alertspost
Get Wildmoka Video Alertsget
Update Wildmoka Video Alertspatch
Delete Wildmoka Video Alertsdel

Program bans

Program Bans
Create a Program Banpost
Get Program Bansget
Delete a Program Bandel

Pinned Comments

Pinning a commentpost
Unpin a pinned commentdel
List Pinned Commentsget

Status Tiers

Using Status Tiers
Create Tier Grouppost
List Tier Groupsget
Update Tier Grouppatch
Delete a Tier Groupdel
Create Tierpost
List Tiersget
Retrieve a Tierget
Update Tierpatch
Delete Tierdel
Create Tier Benefitpost
List Tier Benefitsget
Retrieve Tier Benefitget
Update Tier Benefitpatch
Delete Tier Benefitdel
Assigning tier to a profile

Claim user quest rewards

patch https://cf-blast.livelikecdn.com/api/v1/user-quests/{user-quest-id}/

Language

Click Try It! to start a request and see the response here!