Chat REST API Developer Guide

Overview
Getting Started with the Chat REST API
Request Headers
Your Message Long Polling Loop
Using Estimated Wait Time Instead of Queue Position for a Chat Session (Beta)
Chat REST API Resources
Request Bodies for Chat REST API
Response Bodies for Chat REST API
Chat REST API Data Types
Status Codes and Error Responses
PDF

Overview

Take Chat to a native mobile app or a custom client using the Chat REST API.
Available in: Salesforce Classic and Lightning Experience
Available in: Performance Editions and in Developer Edition orgs that were created after June 14, 2012

Available in: Essentials, Unlimited, and Enterprise Editions with Service Cloud or Sales Cloud

The legacy chat product is scheduled for retirement on February 14, 2026, and is in maintenance mode until then. During this phase, you can continue to use chat, but we no longer recommend that you implement new chat channels. To avoid service interruptions to your customers, migrate to Messaging for In-App and Web. Messaging offers many of the chat features that you love plus asynchronous conversations that can be picked back up at any time. Learn about chat retirement in Help.

Note

You don’t have to rely on Visualforce to develop customized chat windows. With the REST resources in this guide, you can extend the functionality of chat windows beyond simple HTML and JavaScript environments that merge seamlessly into your company’s own applications.

Chat REST API doesn’t support building custom clients that work with Einstein Bots. See Einstein Bots API and SDK.

Note