social.plus home page
Search...
⌘K
Ask AI
Login
Talk to Sales
Talk to Sales
Search...
Navigation
Introduction
Welcome
SDK
UIKit
Analytics & Moderation
API
social.plus APIs & Services
social.plus APIs and Services
Network Settings
Webhook Events
Pre-Hook Events
User Activity Reports
Ads
GET
Query all network ads and settings
Archive
GET
Query all archived channels
POST
Archive channels
DEL
Unarchive channels
Analytic
POST
send analytic activities
GET
query post reach
GET
query story reach
Authentication
GET
Get authentication token
deprecated
POST
Create authentication token for session creation API
Channel
POST
close channel
PUT
Mute channel
PUT
Mute user in channel
GET
Search channels
GET
Query channel
POST
Create channel
POST
Bulk mark seen
GET
get a channel by ID.
PUT
update a channel
DEL
delete a channel
POST
join a channel
DEL
leave a channel
POST
Mark user message read position inside channel
GET
query channel users
POST
add channel users
DEL
remove channel users
PUT
ban channel users
PUT
unban channel users
POST
Add role to channel users
DEL
Remove role from channel users
POST
create a conversation channel
GET
get list of channel
GET
Query Channel Users
Comment
GET
query comments
POST
create a comment.
GET
get a comment.
PUT
update a comment.
DEL
delete a comment.
deprecated
POST
flag a comment.
GET
Check whether user flag a given comment.
DEL
unflag a comment.
GET
get comments by IDs.
DEL
clear flags.
DEL
delete a comment.
Community
GET
query communities.
POST
create a community.
GET
get a community by ID.
PUT
update a community.
DEL
delete a community.
POST
Join a community
deprecated
DEL
Leave a community.
GET
Query Community Users
POST
add community users
deprecated
DEL
remove community users
PUT
ban community users
PUT
unban community users
POST
Add role to community users
DEL
Remove role from community users
GET
Get self permission in community
GET
get list of community
GET
get list of recommended community
GET
get list of top trend community
POST
Add roles to community users
DEL
Remove roles from community users
GET
Query join requests
POST
Join a community
DEL
Cancel join requests
GET
Get user's join requests
POST
Approve a join request
POST
Reject a join request
GET
Count join requests
GET
Get join request list
Community category
GET
query community categories.
POST
create a community categories.
GET
get a community category.
PUT
update a community categories.
DEL
delete a community category.
GET
get list of community category.
Invitation
GET
Get invitations
POST
Create invitations
POST
Accept an invitation
POST
Reject an invitation
DEL
Cancel an invitation
GET
Get my invitations
GET
Count invitations
POST
Resend an invitation
Feed
GET
Get following feeds
GET
Get list of contents.
GET
Get list of posts.
deprecated
GET
Get global feed.
GET
Get list of posts.
deprecated
GET
Get number of post.
GET
Get global feed.
GET
Get global feed.
File
POST
Upload file.
GET
Get file info
PUT
Update file info.
DEL
Delete file
GET
Download file
POST
Upload image file.
POST
Upload file.
POST
Upload video file.
POST
Upload clip file.
POST
Upload image from URL.
POST
Upload video from URL.
POST
Upload file from URL.
Follow
POST
Follow user.
DEL
Unfollow or Cancel follow request
POST
Accept follow request.
DEL
Decline follow request or delete followers.
GET
Get my follower list.
GET
Get other follower list.
GET
Get my following list
GET
Get other following list.
GET
Get my follow information.
GET
Get other follow information.
GET
Get other follow information.
Global Featured Post
GET
Query global pinned post
DEL
Clear all global pinned post in a global feed
POST
Global pin a post in a global feed
DEL
Global Unpin a post in a global feed
Marker
GET
Get marker for channels
PUT
Mark all messages in channel as read
GET
Get marker for message feeds
PUT
Mark message feeds as delivering
PUT
Mark message feeds as read
POST
Start reading message feeds
POST
Stop reading message feeds
POST
Mark message feeds as read
GET
Get marker for messages
GET
Get list of users who delivered the message
GET
Get list of users who read the message
POST
Marker sync
GET
Query Latest 100 user feed marker by a list of entity Id (channel id)
GET
Get marker for user
Moderation
PUT
Refresh black list
POST
Add rules to black list
DEL
Delete rules from black list
GET
get rules of blacklist.
PUT
refresh rules of blacklist.
POST
add rules to blacklist.
DEL
delete rules from blacklist
PUT
update rule of blacklist.
GET
get a moderation setting
PUT
update a moderation setting
GET
get rules of whitelist.
PUT
refresh rules of whitelist.
POST
add rules to whitelist.
DEL
delete rules from whitelist
PUT
update rule of whitelist.
GET
Get list of allowed words
POST
Add rules of allowlist V3
GET
Get list of banned words
POST
Add rules of blocklist V3
POST
Verify allowlist
POST
Verify blocklist
Message Feed
POST
Add a new message feed
GET
Find a message feed by ID
PUT
Update a message feed
DEL
Delete a message feed
GET
Finds message feeds by channelId and multiple conditions
GET
Find message feeds by list of ID's
GET
Finds message feeds by creatorId and multiple conditions
Message
GET
query messages
POST
create a message
GET
get list of messages
GET
get a message
PUT
update a message
DEL
delete a message
POST
flag a message
DEL
unflag a message
DEL
clear flags
GET
is message flag by me
GET
Find message by message feed id and multiple conditions
POST
Create a new message in message feed
GET
Find message by ID
PUT
Update a message
DEL
Delete a message
DEL
Delete all flags in message
GET
Find my flag in message by ID
POST
Create my flag in a message
DEL
Delete my flag in a message
GET
Find messages by message id (max=10)
GET
Find messages by creatorId
Network Setting
PUT
Update network setting configuration.
GET
Get chat network setting configuration.
PUT
Update chat network setting configuration.
GET
Get feed setting check configuration.
PUT
Update feed setting check configuration.
GET
Get moderation configuration.
PUT
Update moderation configuration.
GET
Get prehook configuration.
PUT
Update prehook configuration
GET
Get social configuration.
PUT
Update social configuration.
GET
Get Network setting for Semantics search.
PUT
Update Semantics search configuration.
GET
Get users configuration.
PUT
Update users configuration
GET
Get video streaming setting check configuration.
PUT
Update video streaming setting check configuration.
GET
Get webhook configuration.
PUT
Update webhook configuration.
GET
Get UIKit config
PUT
Update UIKit config
GET
Get shareable deep links configuration
PUT
Create shareable deep links configuration
Notification
POST
register a device to get push notification
DEL
unregister a device from a notification service provider
GET
Get push notification setting.
POST
Save push notification setting.
Notification Tray
GET
Get user's notification tray items
GET
Get notification tray seen status
POST
Mark all notifications as seen
POST
Mark specific notifications as seen
Pin post
GET
List all pinned posts in a community
DEL
Clear all pin posts in a community
GET
List all pinned posts in a community by placement
DEL
Clear all pin posts in a community by placement
POST
Pin a post in a community
DEL
Unpin a post in a community
Poll
POST
create a poll
GET
get poll
PUT
update status poll
DEL
delete poll
POST
vote poll
GET
List users who vote the poll with specific answer
Post
GET
query posts
POST
create a post
GET
get a post by ID
PUT
update a post
DEL
delete a post
POST
Approve reviewing post
POST
Decline reviewing post
POST
flag a post.
GET
Check whether user flag a given post.
DEL
unflag a post.
GET
get list of post
DEL
clear flags
GET
query posts
POST
create a post
PUT
update a post
DEL
delete a post
GET
query posts
Presence
GET
Get presence feature setting on both network and user level
PUT
Update presence feature setting on user level
GET
Get presence state of provided user list
GET
Get online users in a network
GET
Get number of online users in a network
POST
Send a presence heartbeat
Reaction
POST
Send live reactions
GET
Get message ids by the most of reactions.
GET
get list of reactions.
POST
add reaction to any document.
DEL
remove reaction from any document.
GET
get list of reactions.
Role
GET
get all roles
PUT
add permissions.
GET
Get roles (pagination support)
POST
Create role
GET
Get role
PUT
Update role
DEL
Delete role
Semantic Search
GET
Semantic search posts
GET
Semantic search community
Session
GET
Verify access token
POST
Register a session
deprecated
POST
Register a session
DEL
Revoke access token
DEL
Revoke all user's access tokens by admin
Story
GET
Query stories by target
POST
Create a story
GET
Count stories by target
GET
Query story targets by multiple targets
GET
Query stories by multiple targets
GET
Get a story
DEL
Delete a story
POST
Flag a story
DEL
Unflag a story
DEL
Clear all flags in a story.
GET
Get global story targets
User
GET
Get a User
GET
Get Users
GET
Query Users
PUT
Update a User
GET
Check whether User Flagged a given User
GET
Get Blocked Users
POST
Ban a User
POST
Unban a User
POST
Report a User
DEL
Unreported a User
DEL
Clear Flag a User
DEL
Delete a User
POST
Block a User
DEL
Unblock a User
Video streaming
POST
create user event for video streaming
GET
get list of video streaming
POST
create video streaming
GET
get single video-streaming item
PUT
update video streaming
DEL
delete video streaming
DEL
dispose video streaming url
GET
get list of banned viewers
POST
ban viewers from a live stream
DEL
unban viewers from a live stream
Webhook event
GET
Channel users added webhook
GET
Channel Didban webhook event
GET
Channel Didclose webhook event
GET
Channel Didcreate webhook event
GET
Channel Didjoin webhook event
GET
Channel Didleave webhook event
GET
Channel Didremoveusers webhook event
GET
Channel Didupdate webhook event
GET
Channel Didupdatemeta webhook event
GET
Follow Didacceptrequest webhook event
GET
Follow Didcancelrequest webhook event
GET
Follow Didcreate webhook event
GET
Follow Diddeclinerequest webhook event
GET
Follow Diddeletefollower webhook event
GET
Follow Didrequest webhook event
GET
Follow Didunfollow webhook event
GET
Message Didaddreaction webhook event
GET
Message Didclearflag webhook event
GET
Message Didcreate webhook event
GET
Message Diddelete webhook event
GET
Message Didflag webhook event
GET
Message Didremovereaction webhook event
GET
Message Didunflag webhook event
GET
Message Didupdate webhook event
GET
Moderation Didban webhook event
GET
Poll Didcreate webhook event
GET
Poll Didupdate webhook event
GET
Poll Didvote webhook event
GET
Channel Created webhook event
GET
Channel Joined webhook event
GET
Comment Created webhook event
GET
Comment Reacted webhook event
GET
Comment Replied webhook event
GET
Follow Accepted webhook event
GET
Follow Created webhook event
GET
Follow Requested webhook event
GET
Message Created webhook event
GET
Post Approved webhook event
GET
Post Created webhook event
GET
Post Need Reviewing webhook event
GET
Post Reacted webhook event
GET
Video Streaming Started webhook event
GET
Mention Comment Created webhook event
GET
Mention Comment Replied webhook event
GET
Mention Post Created webhook event
GET
Mention User Feed Comment Created webhook event
GET
Mention User Feed Comment Replied webhook event
GET
Mention User Feed Post Created webhook event
GET
User Didclearflag webhook event
GET
User Didcreate webhook event
GET
User Didflag webhook event
GET
User Didunflag webhook event
GET
User Didupdate webhook event
GET
Comment Didaddreaction webhook event
GET
Comment Didcreate webhook event
GET
Comment Diddelete webhook event
GET
Comment Didflag webhook event
GET
Comment Didremovereaction webhook event
GET
Comment Didreply webhook event
GET
Comment Didunflag webhook event
GET
Comment Didupdate webhook event
GET
Comment Didmoderate webhook event
GET
Community Didaddusers webhook event
GET
Community Didban webhook event
GET
Community Didcreate webhook event
GET
Community Diddelete webhook event
GET
Community Didjoin webhook event
GET
Community Didleave webhook event
GET
Community Didremoveusers webhook event
GET
Community Didrolechange webhook event
GET
Community Didunban webhook event
GET
Community Didupdate webhook event
GET
Community Join Request Did Create webhook event
GET
Community Join Request Did Accept webhook event
GET
Community Join Request Did Reject webhook event
GET
Community Member Invitation Did Create webhook event
GET
Community Member Invitation Did Accept webhook event
GET
Community Member Invitation Did Reject webhook event
GET
Post Didaddreaction webhook event
GET
Post Didapprove webhook event
GET
Post Didcreate webhook event
GET
Post Diddecline webhook event
GET
Post Diddelete webhook event
GET
Post Didflag webhook event
GET
Post Didremovereaction webhook event
GET
Post Didunflag webhook event
GET
Post Didupdate webhook event
GET
Post Didmoderate webhook event
GET
Video Streaming Didrecord webhook event
GET
Video Streaming Didstart webhook event
GET
Video Streaming Didstop webhook event
GET
Message Didcreate webhook event
GET
Message Diddelete webhook event
GET
Message Didupdate webhook event
Realtime event
GET
user is banned from the channel
GET
channel created
GET
channel deleted
GET
user joined the channel
GET
user left the channel
GET
users were added to the channel
GET
users were removed from the channel
GET
user is unbanned from the channel
GET
channel updated
GET
channel setMuted
GET
channel setMutedUsers
GET
comment add reaction
GET
comment created
GET
comment deleted
GET
comment flagged
GET
comment flag cleared
GET
comment remove reaction
GET
comment unflagged
GET
comment updated
GET
community created
GET
community deleted
GET
community joined
GET
community left
GET
community updated
GET
community user added
GET
community user banned
GET
community user changed
GET
community user removed
GET
community user unbanned
GET
follow accepted
GET
follow created
GET
delete follower
GET
follow request canceled
GET
decline follow request
GET
follow requested
GET
unfollowed
GET
live reactions created
GET
marked message in marker
GET
user sync in marker
GET
user feed updated in marker
GET
feed updated in marker
GET
message feed created
GET
message feed deleted
GET
message feed updated
GET
message reaction added
GET
message created
GET
message deleted
GET
message flag cleared
GET
message flagged
GET
message reaction added
GET
message reaction removed
GET
message unflagged
GET
message updated
GET
post add reaction
GET
post approved
GET
post created
GET
post declined
GET
post deleted
GET
post flagged
GET
post flag cleared
GET
post remove reaction
GET
post unflagged
GET
post updated
GET
story created
GET
story deleted
GET
story reaction added
GET
story reaction removed
GET
user deleted
GET
user global banned
GET
user flag cleared
GET
user flagged
GET
user unflagged
GET
user updated
GET
video-streaming viewer did ban
GET
video-streaming viewer did unban
On this page
Welcome
Authentication
Introduction
Example section for showcasing API endpoints
If you’re not looking to build API reference documentation, you can delete this section by removing the api-reference folder.
Welcome
There are two ways to build API documentation:
OpenAPI
and
MDX components
. For the starter kit, we are using the following OpenAPI specification.
Plant Store Endpoints
View the OpenAPI specification file
Authentication
All API endpoints are authenticated using Bearer tokens and picked up from the specification file.
Copy
Ask AI
"security"
: [
{
"bearerAuth"
: []
}
]
Assistant
Responses are generated using AI and may contain mistakes.