social.plus APIs & Services
Data Model Reference
Analytic
Authentication
Channel
- POSTclose channel
- PUTMute channel
- PUTMute user in channel
- GETSearch channels
- GETQuery channel
- POSTCreate channel
- POSTBulk mark seen
- GETget a channel by ID.
- PUTupdate a channel
- DELdelete a channel
- POSTjoin a channel
- DELleave a channel
- POSTMark user message read position inside channel
- GETquery channel users
- POSTadd channel users
- DELremove channel users
- PUTban channel users
- PUTunban channel users
- POSTAdd role to channel users
- DELRemove role from channel users
- POSTcreate a conversation channel
- GETget list of channel
- GETQuery Channel Users
Message
- GETSearch messages
- GETquery messages
- POSTcreate a message
- GETget list of messages
- GETget a message
- PUTupdate a message
- DELdelete a message
- POSTflag a message
- DELunflag a message
- DELclear flags
- GETis message flag by me
- GETFind message by message feed id and multiple conditions
- POSTCreate a new message in message feed
- GETFind message by ID
- PUTUpdate a message
- DELDelete a message
- DELDelete all flags in message
- GETFind my flag in message by ID
- POSTCreate my flag in a message
- DELDelete my flag in a message
- GETFind messages by message id (max=10)
- GETFind messages by creatorId
Comment
Community
- GETquery communities.
- POSTcreate a community.
- GETget a community by ID.
- PUTupdate a community.
- DELdelete a community.
- POSTJoin a communitydeprecated
- DELLeave a community.
- GETQuery Community Users
- POSTadd community usersdeprecated
- DELremove community users
- PUTban community users
- PUTunban community users
- POSTAdd role to community users
- DELRemove role from community users
- GETGet self permission in community
- GETget list of community
- GETget list of recommended community
- GETget list of top trend community
- POSTAdd roles to community users
- DELRemove roles from community users
- GETQuery join requests
- POSTJoin a community
- DELCancel join requests
- GETGet user's join requests
- POSTApprove a join request
- POSTReject a join request
- GETCount join requests
- GETGet join request list
Community category
Event
Invitation
Product
- GETQuery products
- POSTCreate product
- DELDelete products (bulk)
- GETGet product by ID
- PUTUpdate product
- GETSearch products
- GETCount products
- GETGet products by IDs
- GETDownload bulk import sample CSV
- GETQuery bulk product import jobs
- POSTCreate bulk product import job
- GETGet bulk product import job by ID
- POSTStart bulk product import job
Feed
File
Follow
- POSTFollow user.
- DELUnfollow or Cancel follow request
- POSTAccept follow request.
- DELDecline follow request or delete followers.
- GETGet my follower list.
- GETGet other follower list.
- GETGet my following list
- GETGet other following list.
- GETGet my follow information.
- GETGet other follow information.
- GETGet other follow information.
Global Featured Post
Marker
- GETGet marker for channels
- PUTMark all messages in channel as read
- GETGet marker for message feeds
- PUTMark message feeds as delivering
- PUTMark message feeds as read
- POSTStart reading message feeds
- POSTStop reading message feeds
- POSTMark message feeds as read
- GETGet marker for messages
- GETGet list of users who delivered the message
- GETGet list of users who read the message
- POSTMarker sync
- GETQuery Latest 100 user feed marker by a list of entity Id (channel id)
- GETGet marker for user
Moderation
- GETQuery moderation activity reports
- GETDownload moderation activity report
- PUTRefresh black list
- POSTAdd rules to black list
- DELDelete rules from black list
- GETget rules of blacklist.
- PUTrefresh rules of blacklist.
- POSTadd rules to blacklist.
- DELdelete rules from blacklist
- PUTupdate rule of blacklist.
- GETget a moderation setting
- PUTupdate a moderation setting
- GETget rules of whitelist.
- PUTrefresh rules of whitelist.
- POSTadd rules to whitelist.
- DELdelete rules from whitelist
- PUTupdate rule of whitelist.
- GETGet list of allowed words
- POSTAdd rules of allowlist V3
- GETGet list of banned words
- POSTAdd rules of blocklist V3
- POSTVerify allowlist
- POSTVerify blocklist
User
- GETGet Users Last Activity Report
- GETGet Bulk User Delete Jobs
- POSTCreate Bulk User Delete Job
- GETGet a User
- GETGet Users
- GETQuery Users
- PUTUpdate a User
- GETCheck whether User Flagged a given User
- GETGet Blocked Users
- POSTBan a User
- POSTUnban a User
- POSTReport a User
- DELUnreported a User
- DELClear Flag a User
- DELDelete a User
- POSTBlock a User
- DELUnblock a User
Message Feed
Network Setting
- GETGet chat network setting configuration.
- PUTUpdate chat network setting configuration.
- GETGet feed setting check configuration.
- PUTUpdate feed setting check configuration.
- GETGet moderation configuration.
- PUTUpdate moderation configuration.
- GETGet prehook configuration.
- PUTUpdate prehook configuration
- GETGet social configuration.
- PUTUpdate social configuration.
- GETGet Network setting for Semantics search.
- PUTUpdate Semantics search configuration.
- GETGet users configuration.
- PUTUpdate users configuration
- GETGet public users configuration.
- PUTUpdate public users configuration
- GETGet video streaming setting check configuration.
- PUTUpdate video streaming setting check configuration.
- GETGet room network setting configuration
- GETGet webhook configuration.
- PUTUpdate webhook configuration.
- GETGet UIKit config
- PUTUpdate UIKit config
- GETGet shareable deep links configuration
- PUTCreate shareable deep links configuration
- GETGet network security configuration
- PUTUpdate network security configuration
- GETGet push notification configuration
- PUTUpdate push notification configuration
- GETGet product configuration
- PUTUpdate product configuration
Notification
Notification Tray
Pin post
Post
- GETQuery scheduled posts
- POSTCreate a scheduled post
- PUTUpdate a scheduled post
- DELDelete a scheduled post
- GETquery posts
- POSTcreate a post
- GETget a post by ID
- PUTupdate a post
- DELdelete a post
- POSTApprove reviewing post
- POSTDecline reviewing post
- POSTflag a post.
- GETCheck whether user flag a given post.
- DELunflag a post.
- GETget list of post
- DELclear flags
- GETquery posts
- POSTcreate a post
- PUTupdate a post
- DELdelete a post
- PATCHpatch post data and metadata
- GETquery posts
- GETSearch posts
Poll
Presence
Reaction
Room
- GETget list of rooms
- POSTcreate room
- GETget single room
- PUTupdate room
- DELdelete room
- POSTstop room
- GETget ingest data (stream key or livekit token)
- DELremove participant from room
- GETWatch recorded playback
- GETDownload recorded thumbnail
- GETget list of banned viewers
- POSTban viewers from a room
- DELunban viewers from a room
- POSTStore watching time analytic for room
Role
Semantic Search
Session
Story
Video streaming
- POSTcreate user event for video streaming
- GETget list of video streaming
- POSTcreate video streaming
- GETget single video-streaming item
- PUTupdate video streaming
- DELdelete video streaming
- DELdispose video streaming url
- GETget list of banned viewers
- POSTban viewers from a live stream
- DELunban viewers from a live stream
- GETQuery active live video streaming
Webhook event
- GETChannel users added webhook
- GETChannel Didban webhook event
- GETChannel Didclose webhook event
- GETChannel Didcreate webhook event
- GETChannel Didjoin webhook event
- GETChannel Didleave webhook event
- GETChannel Didremoveusers webhook event
- GETChannel Didupdate webhook event
- GETChannel Didupdatemeta webhook event
- GETFile Diddelete webhook event
- GETFollow Didacceptrequest webhook event
- GETFollow Didcancelrequest webhook event
- GETFollow Didcreate webhook event
- GETFollow Diddeclinerequest webhook event
- GETFollow Diddeletefollower webhook event
- GETFollow Didrequest webhook event
- GETFollow Didunfollow webhook event
- GETMessage Didaddreaction webhook event
- GETMessage Didclearflag webhook event
- GETMessage Didcreate webhook event
- GETMessage Diddelete webhook event
- GETMessage Didflag webhook event
- GETMessage Didremovereaction webhook event
- GETMessage Didunflag webhook event
- GETMessage Didupdate webhook event
- GETModeration Didban webhook event
- GETPoll Didcreate webhook event
- GETPoll Didupdate webhook event
- GETPoll Didvote webhook event
- GETChannel Created webhook event
- GETChannel Joined webhook event
- GETComment Created webhook event
- GETComment Reacted webhook event
- GETComment Replied webhook event
- GETFollow Accepted webhook event
- GETFollow Created webhook event
- GETFollow Requested webhook event
- GETMessage Created webhook event
- GETPost Approved webhook event
- GETPost Created webhook event
- GETPost Need Reviewing webhook event
- GETPost Reacted webhook event
- GETVideo Streaming Started webhook event
- GETMention Comment Created webhook event
- GETMention Comment Replied webhook event
- GETMention Post Created webhook event
- GETMention User Feed Comment Created webhook event
- GETMention User Feed Comment Replied webhook event
- GETMention User Feed Post Created webhook event
- GETUser Didclearflag webhook event
- GETUser Didcreate webhook event
- GETUser Didflag webhook event
- GETUser Didunflag webhook event
- GETUser Didupdate webhook event
- GETComment Didaddreaction webhook event
- GETComment Didcreate webhook event
- GETComment Diddelete webhook event
- GETComment Didflag webhook event
- GETComment Didremovereaction webhook event
- GETComment Didreply webhook event
- GETComment Didunflag webhook event
- GETComment Didupdate webhook event
- GETComment Didmoderate webhook event
- GETCommunity Didaddusers webhook event
- GETCommunity Didban webhook event
- GETCommunity Didcreate webhook event
- GETCommunity Diddelete webhook event
- GETCommunity Didjoin webhook event
- GETCommunity Didleave webhook event
- GETCommunity Didremoveusers webhook event
- GETCommunity Didrolechange webhook event
- GETCommunity Didunban webhook event
- GETCommunity Didupdate webhook event
- GETCommunity Join Request Did Create webhook event
- GETCommunity Join Request Did Accept webhook event
- GETCommunity Join Request Did Reject webhook event
- GETCommunity Member Invitation Did Create webhook event
- GETCommunity Member Invitation Did Accept webhook event
- GETCommunity Member Invitation Did Reject webhook event
- GETPost Didaddreaction webhook event
- GETPost Didapprove webhook event
- GETPost Didcreate webhook event
- GETPost Diddecline webhook event
- GETPost Diddelete webhook event
- GETPost Didflag webhook event
- GETPost Didremovereaction webhook event
- GETPost Didunflag webhook event
- GETPost Didupdate webhook event
- GETPost Didmoderate webhook event
- GETVideo Streaming Didrecord webhook event
- GETVideo Streaming Didstart webhook event
- GETVideo Streaming Didstop webhook event
- GETMessage Didcreate webhook event
- GETMessage Diddelete webhook event
- GETMessage Didupdate webhook event
Realtime event
- GETuser is banned from the channel
- GETchannel created
- GETchannel deleted
- GETuser joined the channel
- GETuser left the channel
- GETusers were added to the channel
- GETusers were removed from the channel
- GETuser is unbanned from the channel
- GETchannel updated
- GETchannel setMuted
- GETchannel setMutedUsers
- GETcomment add reaction
- GETcomment created
- GETcomment deleted
- GETcomment flagged
- GETcomment flag cleared
- GETcomment remove reaction
- GETcomment unflagged
- GETcomment updated
- GETcommunity created
- GETcommunity deleted
- GETcommunity joined
- GETcommunity left
- GETcommunity updated
- GETcommunity user added
- GETcommunity user banned
- GETcommunity user changed
- GETcommunity user removed
- GETcommunity user unbanned
- GETfollow accepted
- GETfollow created
- GETdelete follower
- GETfollow request canceled
- GETdecline follow request
- GETfollow requested
- GETunfollowed
- GETlive reactions created
- GETmarked message in marker
- GETuser sync in marker
- GETuser feed updated in marker
- GETfeed updated in marker
- GETmessage feed created
- GETmessage feed deleted
- GETmessage feed updated
- GETmessage reaction added
- GETmessage created
- GETmessage deleted
- GETmessage flag cleared
- GETmessage flagged
- GETmessage reaction added
- GETmessage reaction removed
- GETmessage unflagged
- GETmessage updated
- GETpost add reaction
- GETpost approved
- GETpost created
- GETpost declined
- GETpost deleted
- GETpost flagged
- GETpost flag cleared
- GETpost remove reaction
- GETpost unflagged
- GETpost updated
- GETstory created
- GETstory deleted
- GETstory reaction added
- GETstory reaction removed
- GETuser deleted
- GETuser global banned
- GETuser flag cleared
- GETuser flagged
- GETuser unflagged
- GETuser updated
- GETroom started broadcasting
- GETroom waiting for reconnection
- GETroom ended broadcasting
- GETroom recording is available
- GETroom information updated
- GETroom was terminated
- GETroom participant joined
- GETroom participant left
- GETroom participant removed
- GETroom users banned
- GETroom users unbanned
- GETroom cohost invitation created
- GETroom cohost invitation accepted
- GETroom cohost invitation rejected
- GETroom cohost invitation cancelled
- GETvideo-streaming viewer did ban
- GETvideo-streaming viewer did unban
Get authentication token
curl --request GET \
--url https://apix.us.amity.co/api/v3/authentication/token \
--header 'x-server-key: <x-server-key>'"s9qne0wEqVb2e05271177748659f574a4e8ab85e08"Authentication
Get authentication token
deprecated
GET
/
api
/
v3
/
authentication
/
token
Get authentication token
curl --request GET \
--url https://apix.us.amity.co/api/v3/authentication/token \
--header 'x-server-key: <x-server-key>'"s9qne0wEqVb2e05271177748659f574a4e8ab85e08"Documentation Index
Fetch the complete documentation index at: https://learn.social.plus/llms.txt
Use this file to discover all available pages before exploring further.
Headers
Server key to authenticate the request
Maximum string length:
150Query Parameters
User ID to get token for
Maximum string length:
100Response
Return authentication token string
The response is of type string.
Example:
"s9qne0wEqVb2e05271177748659f574a4e8ab85e08"
⌘I
Assistant
Responses are generated using AI and may contain mistakes.