Jump to Content
Developer Discussion
Developer Blog
Atlas
Guides
Recipes
API Reference
What's New
Developer Discussion
Developer Blog
Atlas
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
Guides
Recipes
API Reference
What's New
Meta
Search
JUMP TO
Khoros Care API overview
Khoros Care APIs
Analytics Reports
Analytics Reports API reference overview
Get time zone IDs for exports
get
Get job status
get
Create conversation actions report
get
Create user export
get
Download export by run ID
get
Get export job status
get
Get team IDs
get
Create raw author export
post
Create raw combined export
post
Create raw conversations export
post
Create conversation actions export
post
Create conversation action history export
post
Create raw incoming post export
post
Create agent state export
post
Create raw help request export
post
Create raw response export
post
Create raw response approval export
post
Create raw team performance export
post
Run team performance interval export
post
Authentication API v2
Authentication API v2
Return entity JWT status
get
Create JWT token
post
Author API v2
Author v2 API
Attributes and the Author API
Disassociating authors and author attributes from a Person
About conversation IDs
Batch author updates
About Author API PUT actions
Get paginated list of authors
get
Get author details by ID
get
List author records changed today
get
Get author by source network ID
get
Get author by source network ID per instance
get
Get author(s) by network handle
get
Get author(s) by network handle and instance
get
Get conversation IDs by Care author and day
get
Get conversation IDs by author, network ID, and day
get
Get conversation IDs by author network ID, instance, and day
get
Get conversation IDs by author network handle and network
get
Get conversation IDs by author network handle and instance
get
Create Care author
post
Remove Person attributes by network ID and instance
post
Update author by source network ID
put
Update author by network ID and instance
put
Batch update author records by author
put
Update or merge author handles by Care author ID
put
Reactivate author conversations
put
Reactivate instance author conversations
put
Bot API v3
Bot API v3
Registration payload
Incoming Message Payloads
Actions object
Author object
Coordinate object
Properties object
Form Response object
Location object
Media object
Rich Content object
Referral object
Get entity currently controlling conversation by author and network
get
Get bot health status by app ID
get
Get registrations using valid JWT token
get
Get bot registrations by source channel
get
Get bot registration details
get
Monitor request to Bot v3 API
get
Monitor requests by date range, state, and origin
get
Register bot with Khoros Care and the Automation Framework
post
Respond to incoming message (bot to channel)
post
Update author's attributes
put
Update author metadata
put
Pass conversation control
put
Add internal note to bot conversation
put
Change conversation priority
put
Edit bot registration
put
Change bot operating mode
put
Mark conversation resolved
put
Tag message by Care tag ID
put
Untag message by Care tag ID
put
Refresh JWT
put
Move conversation to specified workqueue
put
Delete bot registration
delete
Invalidate JWT
delete
Bot API v2
Bot API v2
Bot API workflows
Bot registration
API callbacks to bots
Finding bot-related conversations for testing
Get bot registration details
get
Get registrations by external ID
get
Get current time to agent response (TAR)
get
Register bot with Khoros Care
post
Register bot with Khoros Care or update registration
put
Hand conversation to Care agent
put
Mark conversation resolved for bot
put
Delete bot registration
delete
Conversation API v2
Conversation API v2
Brand Messenger conversations
Community conversations
Facebook conversations
Instagram conversations
Twitter conversations
Get conversation IDs by author and date
get
Get conversation details by unique ID
get
Get conversation details by display ID
get
Get conversation details by document source ID
get
Conversation Tag Rules v2
Conversation Tag Rules API v2
Get conversation tag rule definitions
get
GDPR API v2
GDPR API v2
Create GDPR request
post
Get GDPR request status
get
Listening API v2
Listening API v2
Listening API object definitions
Validate JSON request of inbound messages
post
Create inbound messages
post
Send batch(es) of messages to be assembled into a case by reference message
post
Delete messages
delete
Smart Views API v2
Smart Views API v2
Get Smart View IDs
get
Tag API v2
Tag API v2
Get tag details
get
Work Queue API v2
Work Queue API v2
Get work queue IDs
get
Work Queue API v1
Work Queue API v1
Get work queues details
get
Agent States API v2
Agent States API v2
Retrieve Defined Agent States
get
Set Agent State by Email
put
Set Agent State by UUID
put
Set Agent State by SSO ID
put
Supervisor Reports API
Supervisor Reports API (Deprecated)
Generating a CSV export (deprecated)
Create CSV export for download
get
Create CSV export for download by date(s)
get
List available report names
get
secure forms api
Get Secure Forms
get
Send a bot response with a secure form
post
API Specifications
Getting Started With Your API
CRM (API SPECIFICATION)
API Specification Introduction
Case
createCase
post
lookupCase
get
updateCase
patch
Customer
searchCustomers
post
bestmatchCustomers
post
createCustomer
post
findCustomer
get
updateCustomer
patch
findCases
get
Meta
Define Object Structures
get
Meta
Learn what you can do with the Meta.
With meta, you can
define object structures
.
