Manage customer relationships and sales with Freshsales CRM
The Freshsales integration provides comprehensive customer relationship management and sales automation capabilities. You can create, retrieve, update, and delete various record types including leads, contacts, accounts, and deals. The integration also supports advanced search functionality with filtering and sorting, making it easy to manage your entire sales pipeline and customer data from initial lead capture through deal closure.
Required:
action
- The operation you want to perform (create, get, update, delete, search)record_type
- The type of record (leads, contacts, accounts, deals, or custom modules)Optional:
fields
- Specific fields to include in the operationfilters
- Search criteria for filtering recordsCreate a new record in Freshsales
Parameters:
record_type
(required) - Type of record to create (leads, contacts, accounts, deals)first_name
(required for leads/contacts) - First namelast_name
(required for leads/contacts) - Last nameemail
(optional) - Email addressphone
(optional) - Phone numberaddress
(optional) - Physical addressname
(required for accounts) - Account/company namewebsite
(optional for accounts) - Company websitecustom_fields
(optional) - Any custom field valuesExample:
Response:
Retrieve a specific record using its unique ID
Parameters:
record_type
(required) - Type of record to retrieveid
(required) - The unique ID of the recordExample:
Response:
Update an existing record in Freshsales
Parameters:
record_type
(required) - Type of record to updateid
(required) - The unique ID of the recordfields
(required) - Object containing fields to updateExample:
Response:
Delete a specific record from Freshsales
Parameters:
record_type
(required) - Type of record to deleteid
(required) - The unique ID of the recordExample:
Response:
Search for records based on query parameters
Parameters:
record_type
(required) - Type of records to searchattribute
(required) - Field to search onoperator
(required) - Search operator (is, is_not, contains, etc.)value
(required) - Value to search forsort_by
(optional) - Attribute to sort bysort_order
(optional) - Sort order (asc or desc)page
(optional) - Page number for pagination (default: 1)per_page
(optional) - Records per page (default: 10)Example:
Response:
The record_type parameter accepts leads, contacts, accounts, deals, or custom module names. When creating or updating records, required fields vary by record type - leads and contacts require first_name and last_name, while accounts require a name field. Search operations support various operators including is, is_not, contains, starts_with, and ends_with. Custom fields can be included in any create or update operation by adding them to the request.