REST API for Conversations

Collaboration REST Endpoints

Collaboration

Enable collaboration among users through conversations.

Add new members to the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/members
Add the specified member to the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/members/{memberID}
Associate a document with the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/associate
Close the followup on the specified message for the specified user.: Method: delete
Path: /social/api/v1/messages/{messageID}/followups/{userID}
Create a new applink for the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/applinks
Create a new conversation.: Method: post
Path: /social/api/v1/conversations
Create a new hybrid link for the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/hybridlinks
Create a new reply to the specified message.: Method: post
Path: /social/api/v1/messages/{messageID}
Create a new top-level message in the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/messages
Create hybrid links.: Method: post
Path: /social/api/v1/hybridlinks
Create new followups on the specified message.: Method: post
Path: /social/api/v1/messages/{messageID}/followups
Create the inbound mail token information.: Method: post
Path: /social/api/v1/inboundmail/token
Delete the hybrid link for the specified hybrid link ID.: Method: delete
Path: /social/api/v1/conversations/{conversationID}/hybridlinks/{hybridlinkID}
Delete the hybrid links.: Method: delete
Path: /social/api/v1/hybridlinks
Delete the specified hybrid link.: Method: delete
Path: /social/api/v1/hybridlinks/{hybridlinkID}
Get a filtered list of all conversations.: Method: get
Path: /social/api/v1/conversations
Get a filtered list of hybrid links.: Method: get
Path: /social/api/v1/hybridlinks
Get a list of folder IDs that have conversations associated with them.: Method: get
Path: /social/api/v1/hierarchicalMembers/{hierarchicalMemberID}
Get all direct and indirect user members of the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/memberships
Get all direct members of the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/members
Get all followups for the specified message.: Method: get
Path: /social/api/v1/messages/{messageID}/followups
Get all likes for the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/likes
Get all likes for the specified message.: Method: get
Path: /social/api/v1/messages/{messageID}/likes
Get all members of the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/allmemberships
Get all properties of the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/properties
Get all stars for the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/stars
Get all top-level messages of the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/messages
Get all user properties of the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/userProperties
Get an archive for the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/archive
Get any followup for the specified user for the specified message.: Method: get
Path: /social/api/v1/messages/{messageID}/followups/{userID}
Get around chats after the specified message.: Method: get
Path: /social/api/v1/messages/{messageID}/around
Get the next chats after the specified message.: Method: get
Path: /social/api/v1/messages/{messageID}/next
Get the previous chats after the specified message.: Method: get
Path: /social/api/v1/messages/{messageID}/previous
Get the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}
Get the specified hybrid link.: Method: get
Path: /social/api/v1/hybridlinks/{hybridlinkID}
Get the specified member of the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/allmemberships/{allmembershipID}
Get the specified member of the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/members/{memberID}
Get the specified message.: Method: get
Path: /social/api/v1/messages/{messageID}
Get the specified property of the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/properties/{propertyID}
Get the specified user properties on the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/userProperties/{userPropertyID}
Get whether this message is starred.: Method: get
Path: /social/api/v1/messages/{messageID}/stars
Like the specified message.: Method: post
Path: /social/api/v1/messages/{messageID}/likes
Mark the followup for the current user on the specified message as read. This does not close the followup.: Method: put
Path: /social/api/v1/messages/{messageID}/followups
Remove the specified member from the specified conversation.: Method: delete
Path: /social/api/v1/conversations/{conversationID}/members/{memberID}
Remove the specified property from the specified conversation.: Method: delete
Path: /social/api/v1/conversations/{conversationID}/properties/{propertyID}
Remove the specified user properties from the specified conversation.: Method: delete
Path: /social/api/v1/conversations/{conversationID}/userProperties/{userPropertyID}
Set a property on the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/properties
Set a user property on the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/userProperties
Set the specified property on the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/properties/{propertyID}
Set the specified user properties on the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/userProperties/{userPropertyID}
Star the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/stars
Star the specified message.: Method: post
Path: /social/api/v1/messages/{messageID}/stars
This will always return an empty list; provided for compliance with REST standards.: Method: get
Path: /social/api/v1/conversations/{conversationID}/hybridlinks
Un-like the specified message.: Method: delete
Path: /social/api/v1/messages/{messageID}/likes
Un-star the specified conversation.: Method: delete
Path: /social/api/v1/conversations/{conversationID}/stars
Un-star the specified message.: Method: delete
Path: /social/api/v1/messages/{messageID}/stars
Update or create the specified hierarchical members.: Method: put
Path: /social/api/v1/hierarchicalMembers/{hierarchicalMemberID}
Update the specified conversation.: Method: patch
Path: /social/api/v1/conversations/{conversationID}
Update the specified conversation.: Method: put
Path: /social/api/v1/conversations/{conversationID}
Update the specified hierarchical members.: Method: patch
Path: /social/api/v1/hierarchicalMembers/{hierarchicalMemberID}
Update the specified message.: Method: patch
Path: /social/api/v1/messages/{messageID}
Update the specified message.: Method: put
Path: /social/api/v1/messages/{messageID}