API reference
Chat conversations
Server-side chat sessions, messages and handoff with an API token (v2.1).
Server https://api.kustomerapp.com/v2.1 · 10 operations
API-token chat endpoints (/v2.1/chat/…) for server-side integrations.
These routes use a Bearer API token and supply customer identity in the JSON body
(customerId, optional trackingId). They are distinct from customer SDK routes
under /c/…, which use a tracking JWT.
For CRM conversation and message objects unrelated to chat sessions, see Core Resources.
Chat Conversations
The server-side chat API lets your backend take part in Kustomer chat with a regular API key. It can open chat sessions for a customer, post messages as the customer, an agent or an assistant, show typing, import bot conversations and record satisfaction ratings.
/v2.1/chat/sessionspostCreate a chat session/v2.1/chat/sessionspostCreate a chat session via handoff/v2.1/chat/handoffgetList messages for a chat session/v2.1/chat/sessions/{id}/messagespostCreate an inbound chat message/v2.1/chat/messagespostCreate an inbound assistant chat message/v2.1/chat/assistant/messagespostCreate an outbound agent chat message/v2.1/chat/outbound/messagespostCreate an outbound assistant chat message/v2.1/chat/outbound/assistant/messagespostShow or hide agent/AI typing indicator/v2.1/chat/outbound/typingputUpdate a chat satisfaction response/v2.1/chat/satisfaction-responses/{id}