> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Freshsales

> How to set up the Freshsales connector, plus the actions and events that are available.

![Freshsales](https://stackone-logos.com/api/freshsales/filled/svg)

Previewv1.5.0[See changelog](https://docs.stackone.com/connectors/freshsales/changelog.md)

[127 actions](#actions) · [1 event](#events) · 1 auth method

CRM
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/freshsales/guides/connector-profile/api-key.md)
>
> No app registration required. The API key inherits the permissions of the user who created it.

Optionally, configure receiving Events for Freshsales into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/freshsales/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/freshsales/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

127 actions

ActionDescription

Create Contact`freshsales_create_contact`

Creates a new contact in Freshsales.

Get Contact`freshsales_get_contact`

Retrieves a contact by ID from Freshsales.

List Contacts`freshsales_list_contacts`

Lists contacts from a specific view in Freshsales.

List Contact Views`freshsales_list_contact_views`

Lists all available contact views (filters) in Freshsales.

Update Contact`freshsales_update_contact`

Updates an existing contact in Freshsales.

Upsert Contact`freshsales_upsert_contact`

Creates or updates a contact based on a unique identifier in Freshsales.

Bulk Upsert Contacts`freshsales_bulk_upsert_contacts`

Creates or updates multiple contacts in bulk in Freshsales.

Bulk Assign Contact Owner`freshsales_bulk_assign_contact_owner`

Assigns an owner to multiple contacts at once in Freshsales.

Clone Contact`freshsales_clone_contact`

Creates a copy of an existing contact in Freshsales.

Delete Contact`freshsales_delete_contact`

Deletes a contact by ID from Freshsales.

Forget Contact (Hard Delete)`freshsales_forget_contact`

Permanently and irreversibly deletes all data for a contact in Freshsales.

Bulk Delete Contacts`freshsales_bulk_destroy_contacts`

Deletes multiple contacts at once in Freshsales.

Manage Contact Team Members`freshsales_manage_contact_team_members`

Adds or removes team members associated with a contact in Freshsales.

List Contact Activities`freshsales_list_contact_activities`

Lists all sales activities associated with a contact in Freshsales.

Create Sales Account`freshsales_create_sales_account`

Creates a new sales account (company) in Freshsales.

Get Sales Account`freshsales_get_sales_account`

Retrieves a sales account by ID from Freshsales.

List Sales Accounts`freshsales_list_sales_accounts`

Lists sales accounts from a specific view in Freshsales.

List Sales Account Views`freshsales_list_sales_account_views`

Lists all available sales account views (filters) in Freshsales.

Update Sales Account`freshsales_update_sales_account`

Updates an existing sales account in Freshsales.

Upsert Sales Account`freshsales_upsert_sales_account`

Creates or updates a sales account based on a unique identifier in Freshsales.

Bulk Upsert Sales Accounts`freshsales_bulk_upsert_sales_accounts`

Creates or updates multiple sales accounts in bulk in Freshsales.

Clone Sales Account`freshsales_clone_sales_account`

Creates a copy of an existing sales account in Freshsales.

Delete Sales Account`freshsales_delete_sales_account`

Deletes a sales account by ID from Freshsales.

Forget Sales Account (Hard Delete)`freshsales_forget_sales_account`

Permanently and irreversibly deletes all data for a sales account in Freshsales.

Bulk Delete Sales Accounts`freshsales_bulk_destroy_sales_accounts`

Deletes multiple sales accounts at once in Freshsales.

Manage Sales Account Team Members`freshsales_manage_sales_account_team_members`

Adds or removes team members associated with a sales account in Freshsales.

Create Deal`freshsales_create_deal`

Creates a new deal in Freshsales.

Get Deal`freshsales_get_deal`

Retrieves a deal by ID from Freshsales.

List Deals`freshsales_list_deals`

Lists deals from a specific view in Freshsales.

List Deal Views`freshsales_list_deal_views`

Lists all available deal views (filters) in Freshsales.

Update Deal`freshsales_update_deal`

Updates an existing deal in Freshsales.

Upsert Deal`freshsales_upsert_deal`

Creates or updates a deal based on a unique identifier in Freshsales.

Bulk Upsert Deals`freshsales_bulk_upsert_deals`

Creates or updates multiple deals in bulk in Freshsales.

Clone Deal`freshsales_clone_deal`

Creates a copy of an existing deal in Freshsales.

Delete Deal`freshsales_delete_deal`

Deletes a deal by ID from Freshsales.

Forget Deal (Hard Delete)`freshsales_forget_deal`

Permanently and irreversibly deletes all data for a deal in Freshsales.

Bulk Delete Deals`freshsales_bulk_destroy_deals`

Deletes multiple deals at once in Freshsales.

Manage Deal Team Members`freshsales_manage_deal_team_members`

Adds or removes team members associated with a deal in Freshsales.

Create Task`freshsales_create_task`

Creates a new task in Freshsales.

Get Task`freshsales_get_task`

Retrieves a task by ID from Freshsales.

List Tasks`freshsales_list_tasks`

Lists tasks from Freshsales filtered by status.

Update Task`freshsales_update_task`

Updates an existing task in Freshsales.

Delete Task`freshsales_delete_task`

Deletes a task by ID from Freshsales.

Create Appointment`freshsales_create_appointment`

Creates a new appointment in Freshsales.

Get Appointment`freshsales_get_appointment`

Retrieves an appointment by ID from Freshsales.

List Appointments`freshsales_list_appointments`

Lists filtered appointments from Freshsales. The filter parameter is mandatory.

Update Appointment`freshsales_update_appointment`

Updates an existing appointment in Freshsales.

Delete Appointment`freshsales_delete_appointment`

Deletes an appointment by ID from Freshsales.

Create Document`freshsales_create_document`

Creates a new CPQ document in Freshsales.

Get Document`freshsales_get_document`

Retrieves a CPQ document by ID from Freshsales.

Update Document`freshsales_update_document`

Updates an existing CPQ document in Freshsales.

Bulk Update Documents`freshsales_bulk_update_documents`

Updates multiple CPQ documents in bulk in Freshsales.

Bulk Assign Document Owner`freshsales_bulk_assign_document_owner`

Assigns an owner to multiple CPQ documents in bulk in Freshsales.

Delete Document`freshsales_delete_document`

Deletes a CPQ document by ID from Freshsales.

Restore Document`freshsales_restore_document`

Restores a deleted CPQ document by ID in Freshsales.

Bulk Delete Documents`freshsales_bulk_delete_documents`

Deletes multiple CPQ documents in bulk in Freshsales.

Bulk Restore Documents`freshsales_bulk_restore_documents`

Restores multiple deleted CPQ documents in bulk in Freshsales.

Forget Document`freshsales_forget_document`

Permanently deletes a CPQ document and all associated data from Freshsales.

Update Document Products`freshsales_update_document_products`

Adds, updates, or removes products associated with a CPQ document in Freshsales.

Get Document Related Products`freshsales_get_document_related_products`

Lists all products associated with a CPQ document in Freshsales.

List Documents`freshsales_list_documents`

Lists active CPQ documents (quotes and proposals) in Freshsales.

Create File`freshsales_create_file`

Uploads and attaches a file to a contact, sales account, deal, or product in Freshsales.

Create File Link`freshsales_create_link`

Attaches a file link (URL) to a contact, sales account, or deal in Freshsales.

List Contact Files`freshsales_list_contact_files`

Lists all files and links attached to a contact in Freshsales.

List Deal Files`freshsales_list_deal_files`

Lists all files and links attached to a deal in Freshsales.

List Sales Account Files`freshsales_list_sales_account_files`

Lists all files and links attached to a sales account in Freshsales.

Get Unified Credentials`freshsales_unified_get_me`

Get the current Freshsales connection's unified credentials and identity.

List Unified Organizations`freshsales_unified_list_organizations`

List unified organizations in Freshsales.

Get Unified Organization`freshsales_unified_get_organization`

Get a unified Freshsales organization by ID.

List Unified Users`freshsales_unified_list_users`

List unified users in Freshsales.

Get Unified User`freshsales_unified_get_user`

Get a unified Freshsales user by ID.

Get Job Status`freshsales_get_job_status`

Retrieves the status and details of a background job in Freshsales.

Create Note`freshsales_create_note`

Creates a new note associated with a contact, deal, or sales account in Freshsales.

Update Note`freshsales_update_note`

Updates the content of an existing note in Freshsales.

Delete Note`freshsales_delete_note`

Deletes a note by ID from Freshsales.

Create Product`freshsales_create_product`

Creates a new product in Freshsales.

Get Product`freshsales_get_product`

Retrieves a product by ID from Freshsales.

Update Product`freshsales_update_product`

Updates an existing product in Freshsales.

Bulk Update Products`freshsales_bulk_update_products`

Updates multiple products in bulk in Freshsales.

Bulk Assign Product Owner`freshsales_bulk_assign_product_owner`

Assigns an owner to multiple products in bulk in Freshsales.

Delete Product`freshsales_delete_product`

Deletes a product by ID from Freshsales.

Restore Product`freshsales_restore_product`

Restores a deleted product by ID in Freshsales.

Bulk Delete Products`freshsales_bulk_delete_products`

Deletes multiple products in bulk in Freshsales.

Bulk Restore Products`freshsales_bulk_restore_products`

Restores multiple deleted products in bulk in Freshsales.

Manage Product Prices`freshsales_manage_product_prices`

Adds, updates, or removes prices for a product in Freshsales.

Update Deal Products`freshsales_update_deal_products`

Adds, updates, or removes products associated with a deal in Freshsales.

List Products`freshsales_list_products`

Lists active products in the Freshsales CPQ product catalog.

Create Sales Activity`freshsales_create_sales_activity`

Creates a new sales activity in Freshsales.

Get Sales Activity`freshsales_get_sales_activity`

Retrieves a sales activity by ID from Freshsales.

List Sales Activities`freshsales_list_sales_activities`

Lists all sales activities from Freshsales.

Update Sales Activity`freshsales_update_sales_activity`

Updates an existing sales activity in Freshsales.

Delete Sales Activity`freshsales_delete_sales_activity`

Deletes a sales activity by ID from Freshsales.

Create List`freshsales_create_list`

Creates a new marketing list in Freshsales.

List Lists`freshsales_list_lists`

Lists all marketing lists in Freshsales.

Update List`freshsales_update_list`

Updates the name of a marketing list in Freshsales.

List Contacts In List`freshsales_list_contacts_in_list`

Lists all contacts belonging to a specific marketing list in Freshsales.

Add Contacts To List`freshsales_add_contacts_to_list`

Adds contacts to a marketing list in Freshsales.

Remove Contacts From List`freshsales_remove_contacts_from_list`

Removes contacts from a marketing list in Freshsales.

Move Contacts Between Lists`freshsales_move_contacts_between_lists`

Moves contacts from one marketing list to another in Freshsales.

Search`freshsales_search`

Searches for records by name or email address in Freshsales.

Filtered Search Contact`freshsales_filtered_search_contact`

Searches for contacts matching exact filter criteria in Freshsales.

Lookup`freshsales_lookup`

Looks up records by exact field value match in Freshsales.

List Owners`freshsales_list_owners`

Lists all users who can be set as record owners in Freshsales.

List Territories`freshsales_list_territories`

Lists all territories defined in Freshsales.

List Deal Stages`freshsales_list_deal_stages`

Lists all deal stages for the default pipeline in Freshsales.

List Deal Stages For Pipeline`freshsales_list_pipeline_deal_stages`

Lists all deal stages for a specific pipeline in Freshsales.

List Deal Pipelines`freshsales_list_deal_pipelines`

Lists all deal pipelines in Freshsales.

List Currencies`freshsales_list_currencies`

Lists all currencies configured in Freshsales.

List Deal Reasons`freshsales_list_deal_reasons`

Lists all deal loss reasons in Freshsales.

List Deal Types`freshsales_list_deal_types`

Lists all deal types (classifications) in Freshsales.

List Lead Sources`freshsales_list_lead_sources`

Lists all lead sources defined in Freshsales.

List Industry Types`freshsales_list_industry_types`

Lists all industry types available in Freshsales.

List Business Types`freshsales_list_business_types`

Lists all business types defined in Freshsales.

List Campaigns`freshsales_list_campaigns`

Lists all campaigns in Freshsales.

List Deal Payment Statuses`freshsales_list_deal_payment_statuses`

Lists all deal payment statuses in Freshsales.

List Deal Products`freshsales_list_deal_products`

Lists all products available for deals in Freshsales.

List Contact Statuses`freshsales_list_contact_statuses`

Lists all contact statuses in Freshsales.

List Lifecycle Stages`freshsales_list_lifecycle_stages`

Lists all lifecycle stages in Freshsales.

List Sales Activity Types`freshsales_list_sales_activity_types`

Lists all sales activity types in Freshsales.

List Sales Activity Outcomes`freshsales_list_sales_activity_outcomes`

Lists all sales activity outcomes in Freshsales.

List Sales Activity Entity Types`freshsales_list_sales_activity_entity_types`

Lists all sales activity entity types in Freshsales.

List Outcomes For Activity Type`freshsales_list_activity_type_outcomes`

Lists all outcomes for a specific sales activity type in Freshsales.

List Designations`freshsales_list_designations`

Lists all team designations in Freshsales.

List Contact Fields`freshsales_list_contact_fields`

Lists all field definitions for contacts in Freshsales.

List Deal Fields`freshsales_list_deal_fields`

Lists all field definitions for deals in Freshsales.

List Sales Account Fields`freshsales_list_sales_account_fields`

Lists all field definitions for sales accounts in Freshsales.

List Sales Activity Fields`freshsales_list_sales_activity_fields`

Lists all field definitions for sales activities in Freshsales.

## Events

Tags

Select all
|
Clear

Webhooks

No tags found

1 event

EventDescriptionTags

Freshsales Webhook`freshsales_webhook_event`

Processes inbound Freshsales workflow ("Trigger Webhook") events.

Webhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.