Freshchat

Freshchat Create Csat

Submit a CSAT (Customer Satisfaction) rating for a resolved conversation. Use this to record customer feedback and satisfaction scores. Returns CSAT response with rating, feedback, and conversation details. Note: Conversation must be resolved before submitting CSAT.

Freshchat Delete Agent

Permanently delete an agent from Freshchat. CAUTION: This is a GDPR-compliant permanent deletion. All agent data will be removed and cannot be recovered. Use with extreme caution. Returns deletion confirmation.

Freshchat Delete User

Permanently delete a user from Freshchat. CAUTION: This is a GDPR-compliant permanent deletion. All user data, conversations, and history will be removed and cannot be recovered. Use with extreme caution. Returns deletion confirmation with user ID and verification link.

Freshchat Extract Report

Request extraction of a Freshchat report. Reports contain raw metrics data for analysis. Returns report_id and link. Use fetch_report to check status and get download URLs. Reports are generated asynchronously and may take time to complete.

Freshchat Fetch Conversations

Retrieve detailed information for a specific conversation using conversation_id. Ideal for monitoring or analyzing a particular interaction. Returns conversation specifics like status, assigned agent/group, channel, properties, and metadata. Note: Does not include messages (use fetch_conversations_messages for that).

Freshchat Fetch Conversations Messages

Get messages from a specific conversation by conversation_id. Use this when you need a message-by-message view of a chat session. Returns message content, sender information (user/agent/bot), timestamps, message parts (text/images/files), and reply parts (buttons/quick replies). Supports pagination and time-based filtering.

Freshchat Fetch Report

Get report status and download links for an extracted report. Returns report status (COMPLETED/PENDING/FAILED), time interval, and S3 download links. Links expire after 1 hour. Use extract_report first to generate a report.

Freshchat Get Historical Metrics

Retrieve historical Freshchat dashboard metrics (accurate up to ~5 minutes ago). Use only canonical metric enum values — do not guess avg_response_time or messages_sent (use team_performance.response_time and team_performance.responses_sent). conversation_metrics.created_interactions is account-level: omit group_by and filter_by. Aggregate metrics require aggregator (avg/median/min/max/p90); count metrics must omit it.

Freshchat Get Instant Metrics

Retrieve real-time instant metrics from Freshchat dashboard. Returns metrics at the current instant (accurate up to real-time). Shows agent presence, availability, and activity status. Can be grouped by group and filtered by specific groups.

Freshchat List Account

Retrieve configuration settings of your Freshchat account. Useful for understanding account-wide configurations and settings. Returns details like account ID, domain, plan type, datacenter, and bundle information.

Freshchat List Agents

Enumerate all agents available in your Freshchat organization with filtering. Use this to manage agent assignments, monitor availability, or find agents in specific groups. Returns agent information such as names, IDs, roles, groups, availability status, and capacity settings.

Freshchat List Channels

List all communication channels (topics) in your Freshchat account with filtering. Use this to configure or modify channel settings, find channels by language, or filter by enabled/public status. Returns channel identifiers, names, icons, welcome messages, tags, and configuration.

Freshchat List Conversations Properties

Access all conversation properties and field definitions in your Freshchat service. Useful for configuring fields or understanding conversation metadata. Returns property details including field types, choices for dropdowns, required status, and default values. Note: Only available for Freshsales Suite accounts.

Freshchat List Groups

Retrieve lists of groups within your Freshchat setup. Useful for organizing agents and managing group-specific engagements. Returns group names, IDs, descriptions, routing type (IntelliAssign/Omniroute), and routing logic.

Freshchat List Roles

Access a list of roles defined in your Freshchat account. Ideal for role management and permissions review. Returns role names, IDs, descriptions, and whether roles are custom or system-defined.

Freshchat List Users

List users from your Freshchat platform with advanced filtering. REQUIRES at least one filter parameter (the API does not support listing all users). Ideal for finding specific users by name, email, phone, reference ID, or date ranges. Returns user details including ID, name, email, phone, status, and custom properties.

Freshchat List Users Conversations

Fetch conversations for a specific user indicated by user_id. Useful for reviewing or managing the user's conversation history. Returns array of conversation IDs associated with the user. Use these IDs with fetch_conversations or fetch_conversations_messages to get full details.

Freshchat Send Message

Send a message to a conversation. Supports plain text, rich content (images, files), and interactive elements (quick reply buttons, URL buttons, carousels). Returns created message object with message ID, timestamps, and content.

Freshchat Upload File

Upload a file to Freshchat storage for use as attachments in messages. Returns file_hash, file_name, file_size, content_type, and security status. Use the file_hash in message_parts when sending messages with file attachments. Provide exactly one of: file_content_base64 (max 1 MB inline), file_url (up to 25 MB), or local_path (absolute path on the user's computer). Use list_local_directory to discover paths, then pass local_path on upload tools. Install MCPBundles Desktop at https://www.mcpbundl

Freshchat Upload Image

Upload an image to Freshchat storage. Returns image URL, thumbnail URL, dimensions (width/height), and content type. Use the image URL in message_parts when sending messages with images. Provide exactly one of: file_content_base64 (max 1 MB inline), file_url (up to 25 MB images), or local_path (absolute path on the user's computer). Use list_local_directory to discover paths, then pass local_path on upload tools. Install MCPBundles Desktop at https://www.mcpbundles.com/desktop if it is not conne

Freshchat Upsert Agent

Create a new agent or update an existing agent in Freshchat. If id is provided, updates the agent. If id is omitted, creates a new agent (email required). Returns created/updated agent object with id, created_time, and updated_time.

Freshchat Upsert Conversation

Create a new conversation or update an existing conversation in Freshchat. If id is provided, updates conversation (status, assignment, properties). If id is omitted, creates new conversation (channel_id, users, messages required). Returns conversation object with conversation_id.

Freshchat Upsert User

Create a new user or update an existing user in Freshchat. If id is provided, updates the user (partial update - only specified fields are changed). If id is omitted, creates a new user (email required). Returns created/updated user object with id, created_time, updated_time, and restore_id.