Jump to Content
Khoros CareDeveloper DiscussionDeveloper BlogAtlas
GuidesRecipesAPI ReferenceWhat's New
Developer DiscussionDeveloper BlogAtlasLog InKhoros Care
API Reference
Log In
GuidesRecipesAPI ReferenceWhat's New

Khoros Care API overview

  • Khoros Care APIs

Analytics Reports

  • Analytics Reports API reference overview
  • Get time zone IDs for exportsget
  • Get job statusget
  • Create conversation actions reportget
  • Create user exportget
  • Download export by run IDget
  • Get export job statusget
  • Get team IDsget
  • Create raw author exportpost
  • Create raw combined exportpost
  • Create raw conversations exportpost
  • Create conversation actions exportpost
  • Create conversation action history exportpost
  • Create raw incoming post exportpost
  • Create agent state exportpost
  • Create raw help request exportpost
  • Create raw response exportpost
  • Create raw response approval exportpost
  • Create raw team performance exportpost
  • Run team performance interval exportpost

Authentication API v2

  • Authentication API v2
  • Return entity JWT statusget
  • Create JWT tokenpost

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 authorsget
  • Get author details by IDget
  • List author records changed todayget
  • Get author by source network IDget
  • Get author by source network ID per instanceget
  • Get author(s) by network handleget
  • Get author(s) by network handle and instanceget
  • Get conversation IDs by Care author and dayget
  • Get conversation IDs by author, network ID, and dayget
  • Get conversation IDs by author network ID, instance, and dayget
  • Get conversation IDs by author network handle and networkget
  • Get conversation IDs by author network handle and instanceget
  • Create Care authorpost
  • Remove Person attributes by network ID and instancepost
  • Update author by source network IDput
  • Update author by network ID and instanceput
  • Batch update author records by authorput
  • Update or merge author handles by Care author IDput
  • Reactivate author conversationsput
  • Reactivate instance author conversationsput

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 networkget
  • Get bot health status by app IDget
  • Get registrations using valid JWT tokenget
  • Get bot registrations by source channelget
  • Get bot registration detailsget
  • Monitor request to Bot v3 APIget
  • Monitor requests by date range, state, and originget
  • Register bot with Khoros Care and the Automation Frameworkpost
  • Respond to incoming message (bot to channel)post
  • Update author's attributesput
  • Update author metadataput
  • Pass conversation controlput
  • Add internal note to bot conversationput
  • Change conversation priorityput
  • Edit bot registrationput
  • Change bot operating modeput
  • Mark conversation resolvedput
  • Tag message by Care tag IDput
  • Untag message by Care tag IDput
  • Refresh JWTput
  • Move conversation to specified workqueueput
  • Delete bot registrationdelete
  • Invalidate JWTdelete

Bot API v2

  • Bot API v2
  • Bot API workflows
  • Bot registration
  • API callbacks to bots
  • Finding bot-related conversations for testing
  • Get bot registration detailsget
  • Get registrations by external IDget
  • Get current time to agent response (TAR)get
  • Register bot with Khoros Carepost
  • Register bot with Khoros Care or update registrationput
  • Hand conversation to Care agentput
  • Mark conversation resolved for botput
  • Delete bot registrationdelete

Conversation API v2

  • Conversation API v2
  • Brand Messenger conversations
  • Community conversations
  • Facebook conversations
  • Instagram conversations
  • Twitter conversations
  • Get conversation IDs by author and dateget
  • Get conversation details by unique IDget
  • Get conversation details by display IDget
  • Get conversation details by document source IDget

Conversation Tag Rules v2

  • Conversation Tag Rules API v2
  • Get conversation tag rule definitionsget

GDPR API v2

  • GDPR API v2
  • Create GDPR requestpost
  • Get GDPR request statusget

Listening API v2

  • Listening API v2
  • Listening API object definitions
  • Validate JSON request of inbound messagespost
  • Create inbound messagespost
  • Send batch(es) of messages to be assembled into a case by reference messagepost
  • Delete messagesdelete

Smart Views API v2

  • Smart Views API v2
  • Get Smart View IDsget

Tag API v2

  • Tag API v2
  • Get tag detailsget

Work Queue API v2

  • Work Queue API v2
  • Get work queue IDsget

Work Queue API v1

  • Work Queue API v1
  • Get work queues detailsget

Agent States API v2

  • Agent States API v2
  • Retrieve Defined Agent Statesget
  • Set Agent State by Emailput
  • Set Agent State by UUIDput
  • Set Agent State by SSO IDput

Supervisor Reports API

  • Supervisor Reports API (Deprecated)
  • Generating a CSV export (deprecated)
  • Create CSV export for downloadget
  • Create CSV export for download by date(s)get
  • List available report namesget

secure forms api

  • Get Secure Formsget
  • Send a bot response with a secure formpost

API Specifications

  • Getting Started With Your API

CRM (API SPECIFICATION)

  • API Specification Introduction
  • Case
    • createCasepost
    • lookupCaseget
    • updateCasepatch
  • Customer
    • searchCustomerspost
    • bestmatchCustomerspost
    • createCustomerpost
    • findCustomerget
    • updateCustomerpatch
    • findCasesget
  • Meta
    • Define Object Structuresget

Customer

Learn about the various actions you can do with the customer.

With customer, you can:

  • Create a customer
  • Search customers
  • Best match the customers
  • Find a customer
  • Find cases
  • Update customer
  • © Khoros, LLC - All Rights Reserved
  • Privacy
  • Security
  • Disclaimer
  • Terms of Use and API Terms