Table of Contents
Freshchat is a modern messaging software built for teams who want to ace customer conversations — marketing, sales, or support.
API Overview
Freshchat is a modern messaging software that empowers businesses to engage with customers across multiple channels, including websites, mobile apps, and social media. It offers a comprehensive suite of features such as live chat, chatbots, knowledge base, and customer relationship management (CRM) capabilities. Freshchat seamlessly integrates with other Freshworks products, enabling businesses to streamline their customer support operations and deliver exceptional customer experiences. Its intuitive interface, customizable features, and robust analytics make it an ideal solution for businesses looking to enhance their customer engagement and drive growth.
Freshchat API Overview: Freshchat provides a robust API that enables developers to integrate Freshchat's functionality into their applications and extend its capabilities. The API documentation is comprehensive and well-organized, providing clear instructions and code samples for various use cases. REST APIs allow developers to perform CRUD (Create, Read, Update, Delete) operations on Freshchat entities, such as conversations, contacts, and messages. Webhooks enable real-time notifications for specific events, allowing developers to build custom integrations and respond to customer interactions promptly. Freshchat also implements rate limits to ensure fair usage of the API and prevent excessive load on its servers. By leveraging the Freshchat API, developers can unlock the full potential of Freshchat and tailor it to meet their specific business requirements.
API Request Limits
Free
100 requests per minute
Growth
500 requests per minute
Pro
1000 requests per minute
Enterprise
2000 requests per minute
SDKs
APIs
Method: GET
Description: Retrieve a list of conversations..
Endpoint: /conversations
Parameters: workspace_id
Method: POST
Description: Create a new conversation..
Endpoint: /conversations
Parameters: workspace_id, name, participants
Method: PUT
Description: Update a conversation..
Endpoint: /conversations/{conversation_id}
Parameters: conversation_id, name, participants
Method: DELETE
Description: Delete a conversation..
Endpoint: /conversations/{conversation_id}
Parameters: conversation_id
Method: GET
Description: Retrieve a list of contacts..
Endpoint: /contacts
Parameters: workspace_id
Method: POST
Description: Create a new contact..
Endpoint: /contacts
Parameters: workspace_id, name, email, phone_number
Method: PUT
Description: Update a contact..
Endpoint: /contacts/{contact_id}
Parameters: contact_id, name, email, phone_number
Method: DELETE
Description: Delete a contact..
Endpoint: /contacts/{contact_id}
Parameters: contact_id
Method: GET
Description: Retrieve a list of messages..
Endpoint: /conversations/{conversation_id}/messages
Parameters: conversation_id
Method: POST
Description: Create a new message..
Endpoint: /conversations/{conversation_id}/messages
Parameters: conversation_id, message
Method: PUT
Description: Update a message..
Endpoint: /conversations/{conversation_id}/messages/{message_id}
Parameters: conversation_id, message_id, message
Method: DELETE
Description: Delete a message..
Endpoint: /conversations/{conversation_id}/messages/{message_id}
Parameters: conversation_id, message_id
FAQ
How do I authenticate with the Freshchat API?
You can authenticate using an API key or an OAuth 2.0 access token. The API key is recommended for most use cases.
What are the rate limits for the Freshchat API?
The rate limits vary depending on the API endpoint. For most endpoints, the limit is 100 requests per minute per API key.
How do I create a sandbox account for testing?
You can create a sandbox account by signing up for a free trial at https://freshchat.com/signup.
What is the difference between a developer account and a production account?
A developer account is intended for testing and development purposes, while a production account is used for live deployments.
How do I handle API errors?
The Freshchat API returns HTTP status codes and error messages to indicate errors. You should handle these errors appropriately in your code.