Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Send Requests
• Authenticate
• Use cURL
• Use Cases
  • Create a Conversation
  • Post a Message to a Conversation
  • Get Conversations
  • Get Conversation Messages
• REST API Features
  • API Security
  • API Versioning
  • Case Sensitivity
  • HTTP Methods
  • Optional Fields and Default Values for JSON Data Representations
  • Return Values
  • Name Patterns
  • URL Encoding
  • Pagination
  • Filters
  • Sort Order
  • Localization
  • Name Field Length Limit
  • HTTP Status Codes and Error Handling
• API Resources
  • Collaboration Resource
  • Configuration Resource
  • Security Resource
  • Social Resource

Tasks

• Collaboration
  • Add new members to the specified conversation.
  • Add the specified member to the specified conversation.
  • Associate a document with the specified conversation.
  • Close the followup on the specified message for the specified user.
  • Create a new applink for the specified conversation.
  • Create a new conversation.
  • Create a new hybrid link for the specified conversation.
  • Create a new reply to the specified message.
  • Create a new top-level message in the specified conversation.
  • Create hybrid links.
  • Create new followups on the specified message.
  • Create the inbound mail token information.
  • Delete the hybrid link for the specified hybrid link ID.
  • Delete the hybrid links.
  • Delete the specified hybrid link.
  • Get a filtered list of all conversations.
  • Get a filtered list of hybrid links.
  • Get a list of folder IDs that have conversations associated with them.
  • Get all direct and indirect user members of the specified conversation.
  • Get all direct members of the specified conversation.
  • Get all followups for the specified message.
  • Get all likes for the specified conversation.
  • Get all likes for the specified message.
  • Get all members of the specified conversation.
  • Get all properties of the specified conversation.
  • Get all stars for the specified conversation.
  • Get all top-level messages of the specified conversation.
  • Get all user properties of the specified conversation.
  • Get an archive for the specified conversation.
  • Get any followup for the specified user for the specified message.
  • Get around chats after the specified message.
  • Get the next chats after the specified message.
  • Get the previous chats after the specified message.
  • Get the specified conversation.
  • Get the specified hybrid link.
  • Get the specified member of the specified conversation.
  • Get the specified member of the specified conversation.
  • Get the specified message.
  • Get the specified property of the specified conversation.
  • Get the specified user properties on the specified conversation.
  • Get whether this message is starred.
  • Like the specified message.
  • Mark the followup for the current user on the specified message as read. This does not close the followup.
  • Remove the specified member from the specified conversation.
  • Remove the specified property from the specified conversation.
  • Remove the specified user properties from the specified conversation.
  • Set a property on the specified conversation.
  • Set a user property on the specified conversation.
  • Set the specified property on the specified conversation.
  • Set the specified user properties on the specified conversation.
  • Star the specified conversation.
  • Star the specified message.
  • This will always return an empty list; provided for compliance with REST standards.
  • Un-like the specified message.
  • Un-star the specified conversation.
  • Un-star the specified message.
  • Update or create the specified hierarchical members.
  • Update the specified conversation.
  • Update the specified conversation.
  • Update the specified hierarchical members.
  • Update the specified message.
  • Update the specified message.
• Configuration
  • Get all configuration properties.
  • Get the specified configuration property.
  • Remove the specified configuration property.
  • Set a configuration property.
  • Set the specified configuration property.
• Security
  • Create a new connection or determine if there is an existing connection. Also used with an empty name and password to get the random ID.
  • Determine if there is an existing connection, or return information about the connection.
  • Disconnect an existing connection.
  • Update an existing connection.
  • Update an existing connection.
• Social
  • Close the specified followup.
  • Get a filtered list of all followups.
  • Get a filtered list of all stars.
  • Get the specified followup.
  • Mark the specified followup read.
  • Star the specified object.
  • Un-star the specified object.