Skip to main content
Freshsales logo
  • Category: crm
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 104
  • Triggers: 0
  • Slug: FRESHSALES
  • Version: 20261101_00

Tools

Slug: FRESHSALES_ADD_MARKETING_LIST_CONTACTSAdd contacts to a Freshsales marketing list. The same official operation also copies contacts that already belong to another list.

Input Parameters

integer
required
Destination marketing-list ID.
array
required
One or more contact IDs to add or copy into the destination list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_BULK_ASSIGN_CONTACT_OWNERReplace the owner of up to 100 Freshsales contacts using explicit contact and owner IDs. Freshsales is known to return a false-success 200 for this endpoint, so this action reads every contact after the write and fails unless every owner_id matches.

Input Parameters

integer
required
Active Freshsales user ID selected from the owners selector.
array
required
One to 100 unique Freshsales contact IDs whose owner will be replaced.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_BULK_ASSIGN_CPQ_RECORDSQueue one owner assignment for selected CPQ products or documents; acknowledgment does not prove completion. Requires Freshsales CPQ to be licensed and enabled. Observed product bulk paths support OAuth; OAuth behavior for document and template paths remains unverified. https://developer.freshsales.io/api/#products

Input Parameters

integer
required
Freshsales user ID to assign as owner.
array
required
Distinct positive Freshsales CPQ record IDs.
string ("product" | "document")
required
CPQ resource family to mutate: product or document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_BULK_DELETE_CPQ_RECORDSQueue soft deletion of selected CPQ products or documents so they remain restorable; acknowledgment does not prove completion. Requires Freshsales CPQ to be licensed and enabled. Observed product bulk paths support OAuth; OAuth behavior for document and template paths remains unverified. https://developer.freshsales.io/api/#products

Input Parameters

array
required
Distinct positive Freshsales CPQ record IDs.
string ("product" | "document")
required
CPQ resource family to mutate: product or document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_BULK_RESTORE_CPQ_RECORDSQueue restoration of selected soft-deleted CPQ products or documents using the PUT methods in Freshsales’ official cURL examples; acknowledgment does not prove completion. Requires Freshsales CPQ to be licensed and enabled. Observed product bulk paths support OAuth; OAuth behavior for document and template paths remains unverified. https://developer.freshsales.io/api/#products

Input Parameters

array
required
Distinct positive Freshsales CPQ record IDs.
string ("product" | "document")
required
CPQ resource family to mutate: product or document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_BULK_UPDATE_CPQ_RECORDSQueue one shared-field update for selected CPQ products or documents. Product pricing and document product-line mutations are not supported by these bulk endpoints; acknowledgment does not prove completion. Requires Freshsales CPQ to be licensed and enabled. Observed product bulk paths support OAuth; OAuth behavior for document and template paths remains unverified. https://developer.freshsales.io/api/#products

Input Parameters

array
required
Distinct positive Freshsales CPQ record IDs.
string ("product" | "document")
required
CPQ resource family to mutate: product or document.
object
Product fields applied to every selected product; use only with resource_type=product.
object
Document fields applied to every selected document; use only with resource_type=document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_CLONE_CONTACTCreate a new Freshsales contact by cloning an existing contact and applying field overrides.

Input Parameters

object
Optional fields to override using Freshsales field names. Omit this or send an empty object to copy all existing contact properties.
integer
required
Existing Freshsales contact ID to clone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_CLONE_CUSTOM_MODULE_RECORDCreate a new Freshsales custom-module record by cloning an existing record and applying field overrides.

Input Parameters

object
required
Fields to override on the clone using Freshsales field names, such as name, owner_id, or custom_field.
integer
required
Existing Freshsales custom-module record ID to clone.
string
required
Internal entity name beginning with cm_; obtain it from GET_CUSTOM_MODULE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_CLONE_DEALClone a Freshsales deal, optionally overriding fields on the new deal.

Input Parameters

integer
required
Deal ID to clone.
object
Optional fields to override on the cloned deal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_CLONE_SALES_ACCOUNTClone a Freshsales sales account, optionally overriding fields on the new account.

Input Parameters

object
Optional fields to override on the clone.
integer
required
Sales-account ID to clone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_CREATE_APPOINTMENTCreate a Freshsales appointment, optionally linked to a CRM record or attendees, and return its ID and related records.

Input Parameters

string
required
Appointment title.
object
CRM record to link to the appointment.
boolean
Whether the appointment is an all-day event.
string
required
Appointment end as an ISO 8601 date-time after starts_at.
string
Appointment location.
array
Freshsales users or CRM records to invite to the appointment.
string
required
Appointment start as an ISO 8601 date-time.
string
Freshsales time-zone label used to interpret the appointment times; examples include UTC, Chennai, and Hawaii.
integer
Freshsales appointment outcome ID to assign.
string
Appointment details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_CREATE_CONTACTCreate a Freshsales contact identified by email addresses, mobile number, Twitter username, or external ID and return its ID and contact fields. Tenant contact-field settings can impose additional requirements; inspect List Contact Fields first.

Input Parameters

string
Contact’s city.
string
Contact’s state or region.
array
Email-address hashes for the contact using the modern emails field. Freshsales deprecates the singular email write field.
string
Acquisition medium that led the contact to the site.
string
Contact’s street address.
string
Contact’s country.
string
Acquisition keyword used by the contact.
string
Unique Twitter username that can identify the contact.
string
Contact’s postal code.
string
Contact’s Facebook username.
string
Contact’s LinkedIn account.
integer
Freshsales user ID to assign as owner.
string
Contact’s job title.
string
Contact’s last name.
string
Contact’s time zone.
string
Contact’s first name.
integer
Freshsales campaign ID that acquired the contact.
string
Unique external identifier that can identify the contact.
string
Contact’s work phone number.
integer
Freshsales territory ID for the contact.
object
Contact custom-field values keyed by Freshsales internal field name.
string
Unique mobile telephone number that can identify the contact.
integer
Freshsales lead-source ID for the contact.
array
One to 10 existing sales accounts. IDs must be unique and exactly one association must be primary.
integer
Freshsales contact-status ID.
integer
Freshsales lifecycle-stage ID.
array
Contact subscription-type hashes, using tenant-supported subscription IDs.
array
Contact subscription-status hashes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_CREATE_CPQ_DOCUMENTCreate a Freshsales quote or other CPQ document and return its confirmed ID. Requires Freshsales CPQ to be licensed and enabled for the connected account. OAuth behavior for CPQ document and template paths remains unverified. Official contract: https://developer.freshsales.io/api/#documents

Input Parameters

string
Configured document stage.
number
Document amount; cannot be directly updated after products are attached.
integer
required
Deal ID the document belongs to.
integer
Assigned Freshsales user ID.
integer
required
Contact ID the document belongs to.
string
Document validity timestamp.
string
Billing city.
object
Custom fields keyed by Freshsales internal field name.
string
required
Unique document display name.
integer
Territory ID.
string
Billing state or region.
string
required
Required document currency code from the tenant’s configured currency selector.
string
required
Configured CPQ document type.
string
Shipping city.
string
Shipping state or region.
string
Billing street address.
string
Billing country.
string
Billing postal code.
integer
Sales-account ID the document belongs to.
string
Shipping street address.
string
Shipping country.
string
Shipping postal code.
string
required
Existing CPQ template name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_CREATE_CUSTOM_FIELDCreate a persistent custom field on one explicit Freshsales entity form. This mutates tenant schema, may make future record writes require the field, and cannot be undone through any documented custom-field delete endpoint. Requires confirm_irreversible_schema_change=true.

Input Parameters

string
Optional help text for the field.
string ("text" | "decimal" | "dropdown" | "radio" | "auto_complete" | "multi_select_dropdown")
required
Custom-module field type documented by Freshsales.
string
required
User-visible custom-field label.
array
Choice hashes required for dropdown, radio, and multi-select fields.
integer
required
Explicit form ID obtained from List Entity Forms.
boolean
Whether users can see the field.
boolean
Whether users can edit the field.
boolean
Whether the form requires this field.
string
Optional parent field-group string/UUID. Legacy positive integer IDs are also accepted and serialized as strings. When omitted, Freshsales uses the Basic information group.
string
required
Freshsales entity type that owns the form.
object
Type-specific options. auto_complete requires lookup_type; decimal fields may use locale.
string
Optional stable internal name. Freshsales requires it for dropdown fields and otherwise documents it as optional.
boolean
required
Must be true to confirm a persistent tenant-schema change. The researched API exposes no custom-field delete endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_CREATE_CUSTOM_MODULECreate a tenant-wide Freshsales custom-module definition and return its ID and internal entity name. This changes the tenant’s CRM schema, immediately creates five saved filters, and consumes one of the documented maximum of 10 custom modules per account.

Input Parameters

string ("icon-cm-auction" | "icon-cm-cart" | "icon-cm-connection" | "icon-cm-courses" | "icon-cm-employee" | "icon-cm-event" | "icon-cm-inventory" | "icon-cm-payments" | "icon-cm-people" | "icon-cm-project" | "icon-cm-property" | "icon-cm-schools" | "icon-cm-sku" | "icon-cm-subscription" | "icon-cm-ticket" | "icon-cm-transactions" | "icon-cm-asset" | "icon-cm-assistant" | "icon-cm-category" | "icon-cm-community" | "icon-cm-competitor" | "icon-cm-entitlement" | "icon-cm-file-attachment" | "icon-cm-fulfillment" | "icon-cm-goals" | "icon-cm-hierarchy" | "icon-cm-id-card" | "icon-cm-idea" | "icon-cm-invoice" | "icon-cm-items" | "icon-cm-labels" | "icon-cm-legal" | "icon-cm-location" | "icon-cm-milestone" | "icon-cm-partner" | "icon-cm-payment" | "icon-cm-purchase-order" | "icon-cm-queue" | "icon-cm-relationship" | "icon-cm-revenue-schedule" | "icon-cm-skill" | "icon-cm-storage" | "icon-cm-survey" | "icon-cm-timesheet")
required
Freshsales custom-module icon identifier from the official allowed list; the icon must be unused by another custom module in the tenant.
integer
Optional numeric Freshsales module status.
string
Purpose of the custom module.
string
Optional stable internal entity name beginning with cm_; Freshsales may generate it when omitted.
string
required
Plural display name for the module, limited by Freshsales to 25 characters.
string
required
Singular display name for the module, limited by Freshsales to 25 characters.
boolean
Whether to show the module in Freshsales navigation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_CREATE_CUSTOM_MODULE_RECORDCreate one record in a named Freshsales custom module and return its record ID and fields.

Input Parameters

string
required
Name of the custom-module record.
integer
Freshsales user ID to assign as owner.
string
required
Internal entity name beginning with cm_; obtain it from GET_CUSTOM_MODULE.
object
Module field values keyed by each field’s Freshsales internal name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_CREATE_DEALCreate a Freshsales deal associated with exactly one existing or new sales account.

Input Parameters

string
required
Required deal name.
number
required
Deal amount.
object
Additional deal fields using Freshsales wire names, such as contacts_added_list and custom_field.
object
New sales account to create and associate with the deal.
integer
Existing Freshsales sales-account ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_CREATE_MARKETING_LISTCreate an empty Freshsales marketing list.

Input Parameters

string
required
Name for the marketing list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_CREATE_NOTECreate a Freshsales note on one lead, contact, sales account, or deal.

Input Parameters

string
required
Text of the note to create.
integer
required
Freshsales ID of the related CRM record.
string ("Lead" | "Contact" | "SalesAccount" | "Deal")
required
Related record type: Lead, Contact, SalesAccount, or Deal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_CREATE_PRODUCTCreate a Freshsales CPQ product and return the provider-confirmed product ID. Requires Freshsales CPQ to be licensed and enabled for the connected account. Product create, get, update, delete, and restore paths support OAuth. Official contract: https://developer.freshsales.io/api/#products

Input Parameters

string
required
Unique product name.
string
Exact product-category label configured in the tenant’s products form; copy it from Freshsales settings.
integer
Assigned Freshsales user ID.
boolean
Whether the product is active.
string
Unique stock-keeping unit.
string
Product validity timestamp.
string
Product description.
object
Custom fields keyed by Freshsales internal field name.
string
Unique product code.
integer
Parent product ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_CREATE_SALES_ACCOUNTCreate a Freshsales sales account with standard, parent-account, or tenant-defined fields.

Input Parameters

string
required
Required sales-account name.
object
Additional account fields using Freshsales wire names, including parent_sales_account and custom_field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_CREATE_SALES_ACTIVITYCreate a Freshsales sales activity with all provider-mandatory time, owner, type, and CRM-target fields.

Input Parameters

string
Activity notes.
string
required
Sales-activity title.
string
required
Activity end in a Freshsales-supported datetime form.
string
Activity location.
integer
required
Freshsales user ID that owns the activity.
string
required
Activity start in a Freshsales-supported datetime form.
object
Custom-field values keyed by Freshsales internal name.
integer
required
Freshsales ID of the related CRM record.
string ("Contact" | "SalesAccount" | "Deal")
required
Related record type: Contact, SalesAccount, or Deal.
integer
required
Configured sales-activity type ID.
integer
Configured outcome ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_CREATE_TASKCreate a Freshsales task with every provider-mandatory assignment, due-date, and CRM-target field.

Input Parameters

string
required
Task title.
string
required
Task due date and time in a Freshsales-supported datetime form.
integer
required
Freshsales user ID that owns the task.
integer
Configured task outcome ID.
string
Task details.
integer
Configured task sales-activity type ID.
array
Users collaborating on the task.
integer
required
Freshsales ID of the related CRM record.
string ("Lead" | "Contact" | "SalesAccount" | "Deal")
required
Related record type: Lead, Contact, SalesAccount, or Deal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_DELETE_APPOINTMENTDelete one Freshsales appointment by ID.

Input Parameters

integer
required
Freshsales appointment ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_DELETE_CONTACTSDelete one or more Freshsales contacts through ordinary deletion rather than permanent forget. Provide contact_id for one contact or contact_ids for a bulk request. This toolkit does not expose a restore operation.

Input Parameters

integer
One Freshsales contact ID to delete through the single-contact endpoint. Mutually exclusive with contact_ids.
array
Two or more Freshsales contact IDs to delete in one bulk request. Mutually exclusive with contact_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_DELETE_CPQ_DOCUMENTSoft-delete one Freshsales CPQ document so it can be restored. Requires Freshsales CPQ to be licensed and enabled for the connected account. OAuth behavior for CPQ document and template paths remains unverified. Official contract: https://developer.freshsales.io/api/#documents

Input Parameters

integer
required
Freshsales CPQ document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_DELETE_CUSTOM_MODULEDelete a Freshsales custom-module definition and change the tenant’s CRM schema. Remove all records from the custom module before calling this action.

Input Parameters

integer
required
Freshsales custom-module definition ID to delete. Remove every record from the custom module before calling this action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_DELETE_CUSTOM_MODULE_RECORDSDelete one or more records from a named Freshsales custom module through ordinary deletion. Provide record_id for one record or record_ids for a bulk request. This action never permanently forgets records or their data.

Input Parameters

integer
One custom-module record ID to delete through the ordinary single-record endpoint. Mutually exclusive with record_ids.
array
Two or more custom-module record IDs to delete in one bulk request. Mutually exclusive with record_id.
string
required
Internal entity name beginning with cm_; obtain it from GET_CUSTOM_MODULE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_DELETE_DEALSOrdinarily delete one deal or bulk-delete multiple deals. This operation is separate from permanent forget.

Input Parameters

integer
One deal ID for ordinary single deletion; mutually exclusive with deal_ids.
array
Two or more deal IDs for ordinary bulk deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_DELETE_NOTEPermanently delete one Freshsales note. Freshsales documents no restore operation; the response contains provider-confirmed deletion fields.

Input Parameters

integer
required
Freshsales note ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_DELETE_PRODUCTSoft-delete one Freshsales CPQ product so it can be restored. Requires Freshsales CPQ to be licensed and enabled for the connected account. Product create, get, update, delete, and restore paths support OAuth. Official contract: https://developer.freshsales.io/api/#products

Input Parameters

integer
required
Freshsales CPQ product ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_DELETE_SALES_ACCOUNTSOrdinarily delete one account or bulk-delete multiple accounts. This is not permanent forget; associated contacts and deals are deleted only when explicitly requested.

Input Parameters

integer
One account ID for ordinary single deletion; mutually exclusive with sales_account_ids.
array
Two or more account IDs for ordinary bulk deletion.
boolean
Also delete associated contacts and deals. Applies to either mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_DELETE_SALES_ACTIVITYDelete one Freshsales sales activity after confirming the provider success code.

Input Parameters

integer
required
Freshsales sales-activity ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_DELETE_TASKDelete one Freshsales task and return provider-confirmed deletion fields.

Input Parameters

integer
required
Freshsales task ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_FORGET_CONTACTPermanently and irreversibly erase one Freshsales contact and associated data. This is not ordinary deletion, cannot be undone by this toolkit, and requires confirm_permanent_erasure=true.

Input Parameters

integer
required
Freshsales contact ID to erase permanently.
boolean
required
Must be true to confirm permanent, irreversible erasure of the contact and its associated data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_FORGET_CPQ_DOCUMENTPermanently and irreversibly delete one CPQ document and all associated data. This cannot be restored and requires confirm_permanent_erasure=true. Requires Freshsales CPQ to be licensed and enabled for the connected account. OAuth behavior for CPQ document and template paths remains unverified. Official contract: https://developer.freshsales.io/api/#documents

Input Parameters

integer
required
Freshsales CPQ document ID.
boolean
required
Must be true to confirm permanent, irreversible erasure of the CPQ document and all associated data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_FORGET_CUSTOM_MODULE_RECORDPermanently and irreversibly erase one Freshsales custom-module record and associated data. This is not ordinary deletion, cannot be undone by this toolkit, and requires confirm_permanent_erasure=true.

Input Parameters

integer
required
Custom-module record ID to erase permanently.
string
required
Internal entity name beginning with cm_; obtain it from Get Custom Module.
boolean
required
Must be true to confirm permanent, irreversible erasure of this record and its associated data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_FORGET_DEALIRREVERSIBLE: permanently erase one Freshsales deal and associated data. This cannot be restored and requires confirm_permanent_erasure=true.

Input Parameters

integer
required
Deal ID to erase permanently.
boolean
required
Must be true to confirm permanent, irreversible erasure of the deal and its associated data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_FORGET_SALES_ACCOUNTIRREVERSIBLE: permanently erase one Freshsales sales account and associated data. This cannot be restored and requires confirm_permanent_erasure=true.

Input Parameters

integer
required
Sales-account ID to erase permanently.
boolean
required
Must be true to confirm permanent, irreversible erasure of the sales account and its associated data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_GET_APPOINTMENTReturn one Freshsales appointment and its related attendees, users, conferences, and notes.

Input Parameters

integer
required
Freshsales appointment ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_GET_CONTACTReturn one Freshsales contact by ID, optionally including related resources.

Input Parameters

array
Related resources to embed in the response.
integer
required
Freshsales contact ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_GET_CPQ_DOCUMENTGet one Freshsales CPQ document, optionally including product line items. Requires Freshsales CPQ to be licensed and enabled for the connected account. OAuth behavior for CPQ document and template paths remains unverified. Official contract: https://developer.freshsales.io/api/#documents

Input Parameters

string
Set to products to include attached product pricing details.
integer
required
Freshsales CPQ document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_GET_CUSTOM_MODULEReturn one Freshsales custom-module definition by ID, including the entity name required by custom-module record tools.

Input Parameters

integer
required
Custom-module definition ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_GET_CUSTOM_MODULE_RECORDReturn one record by ID from a named Freshsales custom module.

Input Parameters

integer
required
Freshsales custom-module record ID.
string
required
Internal entity name beginning with cm_; obtain it from GET_CUSTOM_MODULE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_GET_DEALGet one Freshsales deal by ID, optionally with related resources.

Input Parameters

integer
required
Freshsales deal ID.
array
Documented related resources to embed in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_GET_JOB_STATUSGet bounded, single-request progress and failure details for one Freshsales bulk-upsert job; this does not poll.

Input Parameters

string
required
Bulk-upsert job ID from a Freshsales job_status_url.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_GET_PRODUCTGet one Freshsales CPQ product, optionally including pricing. Requires Freshsales CPQ to be licensed and enabled for the connected account. Product create, get, update, delete, and restore paths support OAuth. Official contract: https://developer.freshsales.io/api/#products

Input Parameters

string
Set to product_pricings to include configured prices.
integer
required
Freshsales CPQ product ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_GET_SALES_ACCOUNTGet one Freshsales sales account by ID, optionally with related resources.

Input Parameters

array
Documented related resources to embed in the response.
integer
required
Freshsales sales-account ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_GET_SALES_ACTIVITYGet one Freshsales sales activity by ID.

Input Parameters

integer
required
Freshsales sales-activity ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_GET_TASKGet one Freshsales task by ID, optionally with collaborators and its CRM target.

Input Parameters

array
Related users and/or targetable record to embed.
integer
required
Freshsales task ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_APPOINTMENTSReturn one page selected by Freshsales’s required appointment filter. Open is documented for upcoming appointments; complete is a separate provider-named filter whose semantics are not further defined. Return the next page number only when Freshsales meta.total proves another page exists. Pages default to 25 appointments (maximum 100); larger pages increase response size and token cost.

Input Parameters

integer
Freshsales page number to return.
string ("open" | "complete")
required
Required provider filter: open is documented for upcoming appointments; complete is a separate provider-named filter whose semantics are not further defined.
array
Related resources to embed in the response.
integer
Appointments per page (default 25, Freshsales maximum 100). Larger pages increase response size, latency, and token cost.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_CONFIGURATION_OPTIONSList one Freshsales configuration option family for IDs needed by CRM operations. Covers all 21 official selectors without exposing arbitrary paths; each selector returns its complete provider-bounded option set and does not expose pagination.

Input Parameters

string ("owners" | "territories" | "deal_stages" | "currencies" | "deal_reasons" | "deal_types" | "lead_sources" | "industry_types" | "business_types" | "campaigns" | "deal_payment_statuses" | "deal_products" | "deal_pipelines" | "contact_statuses" | "sales_activity_types" | "sales_activity_outcomes" | "sales_activity_entity_types" | "lifecycle_stages" | "designations" | "pipeline_deal_stages" | "sales_activity_type_outcomes")
required
Configuration option family to list. Use pipeline_deal_stages for one deal pipeline or sales_activity_type_outcomes for one activity type.
integer
Parent pipeline or sales-activity-type ID. Required only for the two parent-scoped resource values and forbidden otherwise.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_CONTACT_ACTIVITIESReturn activity history for one Freshsales contact. The limit input is a provider result-size hint, not a guaranteed maximum. Inspect meta.has_next and meta.has_previous to determine whether the response is incomplete; this action does not expose an unproven continuation input.

Input Parameters

integer
Provider result-size hint sent to Freshsales; it is not a guaranteed maximum number of returned activities.
array
Related user details to embed; the supported value is user.
integer
required
Freshsales contact ID whose activity history to read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_CONTACT_DOCUMENT_ASSOCIATIONSList the file and web-link associations attached to one Freshsales contact, including referenced links, users, and provider totals. This returns metadata only, not file bytes, and exposes no continuation because Freshsales documents none for this endpoint.

Input Parameters

integer
required
Freshsales contact ID whose attached file and link associations to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_CONTACT_FIELDSList Freshsales contact field definitions, internal names, types, choices, and tenant form metadata for use in contact create and update calls. Freshsales documents no pagination or continuation parameter for this endpoint.

Input Parameters

array
Related field-group metadata to include; the supported value is field_group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_CONTACTS_BY_VIEWReturn one explicitly numbered page from a saved Freshsales contact view, including shaped page totals and the next page number when available.

Input Parameters

integer
One-based Freshsales page number to return.
string
Contact field used to sort this page.
integer
required
Saved contact-view ID returned by List Contact Views.
string ("asc" | "desc")
Ascending or descending sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_CONTACT_VIEWSList saved Freshsales contact views and their IDs for use with contact listing tools. Freshsales documents no pagination or continuation parameter for this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_CUSTOM_MODULE_RECORDSReturn one saved-view page of records from a named Freshsales custom module and a page cursor when more records are available.

Input Parameters

integer
Page cursor returned by a previous call. Omit it for page one and pass next_cursor unchanged to fetch the next page.
integer
required
Saved-view ID returned by LIST_CUSTOM_MODULE_VIEWS.
string
required
Internal entity name beginning with cm_; obtain it from GET_CUSTOM_MODULE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_CUSTOM_MODULE_VIEWSList saved views for a Freshsales custom module and return the view IDs needed to list its records. Freshsales documents no pagination or continuation parameter for this endpoint.

Input Parameters

string
required
Internal entity name beginning with cm_; obtain it from GET_CUSTOM_MODULE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_DEAL_FIELDSList standard and tenant-defined Freshsales deal field definitions. Freshsales documents no pagination or continuation parameter for this endpoint.

Input Parameters

array
Optional documented field metadata; the only supported value is field_group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_DEALS_BY_VIEWReturn one numbered page from a saved Freshsales deal view.

Input Parameters

integer
One-based page number.
string
Field name to sort by.
integer
required
Saved-view ID for this entity family.
string ("asc" | "desc")
Ascending or descending sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_DEAL_VIEWSList saved Freshsales deal views and their IDs. Freshsales documents no pagination or continuation parameter for this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_ENTITY_FORMSList Freshsales forms for a standard or custom entity so callers can obtain an explicit form ID before creating a custom field. Freshsales documents no pagination or continuation parameter for this endpoint.

Input Parameters

string
required
Freshsales entity type, such as contacts or a custom-module internal entity name beginning with cm_.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_MARKETING_LIST_CONTACTSReturn one documented page of contacts in a Freshsales marketing list. Freshsales can reject this endpoint when the account plan lacks the feature.

Input Parameters

integer
One-based result page. Compare this with meta.total_pages to continue.
integer
required
Marketing-list ID whose contacts should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_MARKETING_LISTSReturn one documented page of Freshsales marketing lists.

Input Parameters

integer
One-based result page. Compare this with meta.total_pages to continue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_SALES_ACCOUNT_FIELDSList standard and tenant-defined Freshsales sales-account field definitions. Freshsales documents no pagination or continuation parameter for this endpoint.

Input Parameters

array
Optional documented field metadata; the only supported value is field_group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_SALES_ACCOUNTS_BY_VIEWReturn one numbered page from a saved Freshsales sales-account view.

Input Parameters

integer
One-based page number.
string
Field name to sort by.
integer
required
Saved-view ID for this entity family.
string ("asc" | "desc")
Ascending or descending sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_SALES_ACCOUNT_VIEWSList saved Freshsales sales-account views and their IDs. Freshsales documents no pagination or continuation parameter for this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_SALES_ACTIVITIESReturn one bounded Freshsales sales-activity page (25 records by default, 100 maximum) and an explicit next page number.

Input Parameters

integer
One-based page number; pass next_page back here to continue.
integer
Maximum activities in this bounded page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_SALES_ACTIVITY_FIELDSList standard and tenant-defined Freshsales sales-activity field definitions. Freshsales documents no pagination or continuation parameter for this endpoint.

Input Parameters

array
Optional documented field metadata; the only supported value is field_group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LIST_TASKSReturn one page of Freshsales tasks for exactly one status or due-date filter. The returned next_page is calculated using a 25-record page size; pass it back as page to continue.

Input Parameters

integer
One-based page number; one bounded page is returned per call.
string ("open" | "due_today" | "due_tomorrow" | "overdue" | "completed")
required
Exactly one documented task filter.
array
Related users, targetable records, and/or owners to embed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LOG_PHONE_CALL_FOR_EXISTING_RECORDCreate an irreversible manual call log for one existing Freshsales lead, contact, or sales account and optionally create a note. Freshsales documents no call-log delete operation; explicit confirmation is required.

Input Parameters

object
Optional note; description is mandatory and non-empty when supplied.
integer
Freshsales call outcome ID to assign.
integer
required
Existing Freshsales CRM record ID.
boolean
required
Call direction required by Freshsales: true for incoming, false for outgoing.
string ("lead" | "contact" | "salesAccount")
required
Existing record type: lead, contact, or salesAccount.
boolean
required
Must be true to acknowledge that this creates permanent CRM history and Freshsales documents no call-log delete operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LOG_PHONE_CALL_FOR_NEW_RECORDCreate a new Freshsales contact and an irreversible manual call log associated with it, optionally with a note. Contact-field requirements vary by tenant; provide emails when the tenant requires them, but email is not universally required. Neither effect has a documented call-log rollback; explicit confirmation is required.

Input Parameters

object
Optional note; description is mandatory and non-empty when supplied.
integer
Freshsales call outcome ID to assign.
object
required
Identity, phone, email, and company details for the new contact.
boolean
required
Call direction required by Freshsales: true for incoming, false for outgoing.
string
required
New CRM record type to create; the supported value is contact.
boolean
required
Must be true to acknowledge that this creates permanent CRM history and Freshsales documents no call-log delete operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_LOOKUP_RECORDSLook up exact matches across one or more Freshsales lead, contact, sales-account, or deal types using one compatible standard or custom field. Freshsales returns a provider-bounded result set and exposes no pagination parameters.

Input Parameters

string
required
Exactly one standard field (name, email, or lead company_name) or supported custom text/number/dropdown/radio internal field name.
string
required
Exact name, email, or custom-field value to match.
array
required
Entity types to search. The selected field must exist on every entity; Freshsales rejects incompatible combinations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_MOVE_MARKETING_LIST_CONTACTSMove selected contacts or every contact from one Freshsales marketing list to a different destination list.

Input Parameters

string ("selected" | "all")
required
Move only contact_ids, or move every contact from the source list.
array
Required for selected; forbidden for all.
integer
required
Marketing-list ID from which contacts should be removed.
integer
required
Marketing-list ID that should receive the contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_REMOVE_MARKETING_LIST_CONTACTSRemove selected contacts or every contact from one Freshsales marketing list. This changes list membership, not the contact records.

Input Parameters

integer
required
Marketing-list ID to modify.
string ("selected" | "all")
required
Remove only contact_ids, or remove every contact from the list.
array
Required for selected; forbidden for all.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_RESTORE_CPQ_DOCUMENTRestore one soft-deleted Freshsales CPQ document. Requires Freshsales CPQ to be licensed and enabled for the connected account. OAuth behavior for CPQ document and template paths remains unverified. Official contract: https://developer.freshsales.io/api/#documents

Input Parameters

integer
required
Freshsales CPQ document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_RESTORE_PRODUCTRestore one soft-deleted Freshsales CPQ product. Requires Freshsales CPQ to be licensed and enabled for the connected account. Product create, get, update, delete, and restore paths support OAuth. Official contract: https://developer.freshsales.io/api/#products

Input Parameters

integer
required
Freshsales CPQ product ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_SEARCH_CONTACTS_FILTEREDFind exact-match Freshsales contacts with explicit field/operator/value rules.

Input Parameters

integer
Maximum contacts returned by this non-paginated search (default 10, Freshsales maximum 100).
array
required
One or more exact-match Freshsales contact filter rules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_SEARCH_RECORDSFuzzy-search Freshsales users, standard CRM records, and custom-module records in one bounded request.

Input Parameters

string
required
Fuzzy name or email query.
array
required
One or more entity handles: user, lead, contact, sales_account, deal, or a custom-module entity name. Among standard handles, Freshsales rejects sets of four or more that contain all of user, lead, and contact.
integer
Maximum results returned by this non-paginated search (default 10, Freshsales maximum 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_START_BULK_CONTACT_UPSERTStart an asynchronous upsert of up to 100 Freshsales contacts. Returns only the provider’s job acknowledgment and status URL; this tool does not wait for or verify completion.

Input Parameters

array
required
One to 100 contacts to upsert. Each item requires data and exactly one identifier_name and identifier_value pair.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_START_BULK_DEAL_UPSERTStart an asynchronous upsert of up to 100 deals. Returns acceptance and a status URL but does not verify completion.

Input Parameters

array
required
One to 100 deals, each with exactly one matching identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_START_BULK_SALES_ACCOUNT_UPSERTStart an asynchronous upsert of up to 100 sales accounts. Returns acceptance and a status URL but does not verify completion.

Input Parameters

array
required
One to 100 sales accounts, each with exactly one matching identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPDATE_APPOINTMENTUpdate selected fields or attendees on an existing Freshsales appointment and return the updated appointment and related records.

Input Parameters

object
required
One or more appointment fields or attendees to update.
integer
required
Freshsales appointment ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPDATE_CONTACTUpdate selected fields on an existing Freshsales contact and return the updated contact.

Input Parameters

object
required
One or more mutable contact fields using Freshsales field names; custom fields belong under custom_field.
integer
required
Freshsales contact ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPDATE_CONTACT_TEAM_MEMBERSHIPSAdd, update, or remove Freshsales contact-team memberships using explicit contact, user, and designation IDs. Removing a membership changes that user’s access to the contact; verify all tenant IDs before calling.

Input Parameters

integer
required
Freshsales contact ID.
array
required
Team memberships to add/update or remove. Every item requires explicit user_id and designation_id values; this action never guesses tenant IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPDATE_CPQ_DOCUMENTUpdate document fields or replace its complete product list through the one official PUT contract. Freshworks documents quantity as optional, though some tenants require a positive quantity for every supplied line; products=[] removes all lines. Requires Freshsales CPQ to be licensed and enabled for the connected account. OAuth behavior for CPQ document and template paths remains unverified. Official contract: https://developer.freshsales.io/api/#documents

Input Parameters

string
Configured document stage.
number
Document amount; cannot be directly updated after products are attached.
integer
Deal ID the document belongs to.
string
Automatically set to products when products is supplied.
integer
Assigned Freshsales user ID.
array
Complete replacement product list. Supplying one removes omitted products; an empty list removes all products.
integer
Contact ID the document belongs to.
string
Document validity timestamp.
integer
required
Freshsales CPQ document ID to update.
string
Billing city.
object
Custom fields keyed by Freshsales internal field name.
string
Unique document display name.
integer
Territory ID.
string
Billing state or region.
string
Document currency code.
string
Configured CPQ document type.
string
Shipping city.
string
Shipping state or region.
string
Billing street address.
string
Billing country.
string
Billing postal code.
integer
Sales-account ID the document belongs to.
string
Shipping street address.
string
Shipping country.
string
Shipping postal code.
string
Existing CPQ template name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPDATE_CUSTOM_MODULEUpdate selected display, icon, navigation, or description settings on an existing Freshsales custom-module definition. The internal entity name remains stable when display names change.

Input Parameters

string ("icon-cm-auction" | "icon-cm-cart" | "icon-cm-connection" | "icon-cm-courses" | "icon-cm-employee" | "icon-cm-event" | "icon-cm-inventory" | "icon-cm-payments" | "icon-cm-people" | "icon-cm-project" | "icon-cm-property" | "icon-cm-schools" | "icon-cm-sku" | "icon-cm-subscription" | "icon-cm-ticket" | "icon-cm-transactions" | "icon-cm-asset" | "icon-cm-assistant" | "icon-cm-category" | "icon-cm-community" | "icon-cm-competitor" | "icon-cm-entitlement" | "icon-cm-file-attachment" | "icon-cm-fulfillment" | "icon-cm-goals" | "icon-cm-hierarchy" | "icon-cm-id-card" | "icon-cm-idea" | "icon-cm-invoice" | "icon-cm-items" | "icon-cm-labels" | "icon-cm-legal" | "icon-cm-location" | "icon-cm-milestone" | "icon-cm-partner" | "icon-cm-payment" | "icon-cm-purchase-order" | "icon-cm-queue" | "icon-cm-relationship" | "icon-cm-revenue-schedule" | "icon-cm-skill" | "icon-cm-storage" | "icon-cm-survey" | "icon-cm-timesheet")
New Freshsales icon identifier from the official allowed list.
integer
Optional numeric Freshsales module status.
integer
required
Custom-module definition ID to update.
string
New module description.
string
New plural display name, limited by Freshsales to 25 characters.
string
New singular display name, limited by Freshsales to 25 characters.
boolean
Whether to show the module in Freshsales navigation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPDATE_CUSTOM_MODULE_RECORDUpdate selected fields on one record in a named Freshsales custom module and return the updated record.

Input Parameters

object
required
One or more mutable record fields using Freshsales field names, including name, owner_id, or custom_field values.
integer
required
Freshsales custom-module record ID to update.
string
required
Internal entity name beginning with cm_; obtain it from GET_CUSTOM_MODULE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPDATE_DEALUpdate a Freshsales deal, its contact associations, or replace all deal products. Supplying an empty products list removes every line item.

Input Parameters

object
Mutable deal fields using Freshsales wire names, including contact association lists and custom_field.
integer
required
Deal ID to update.
string
Automatically set to products when products is supplied; otherwise optional related resources.
array
Complete replacement product list; an empty list removes all products.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPDATE_DEAL_TEAM_MEMBERSHIPSAdd, update, or remove team memberships for one Freshsales deal.

Input Parameters

integer
required
Record ID whose team to change.
array
required
Team members to add, update, or remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPDATE_MARKETING_LISTRename an existing Freshsales marketing list.

Input Parameters

string
required
New marketing-list name.
integer
required
Marketing-list ID to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPDATE_NOTEReplace the text and target association of an existing Freshsales note.

Input Parameters

integer
required
Freshsales note ID to update.
string
required
Replacement note text.
integer
required
Freshsales ID of the related CRM record.
string ("Lead" | "Contact" | "SalesAccount" | "Deal")
required
Related record type: Lead, Contact, SalesAccount, or Deal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPDATE_PRODUCTUpdate product fields or add, overwrite, and delete product prices through the one official PUT contract. Requires Freshsales CPQ to be licensed and enabled for the connected account. Product create, get, update, delete, and restore paths support OAuth. Official contract: https://developer.freshsales.io/api/#products

Input Parameters

string
Product name.
string
Automatically set to product_pricings when product_pricings is supplied.
string
Exact product-category label configured in the tenant’s products form; copy it from Freshsales settings.
integer
Assigned Freshsales user ID.
boolean
Whether the product is active.
integer
required
Freshsales CPQ product ID to update.
string
Unique stock-keeping unit.
string
Product validity timestamp.
string
Product description.
object
Custom fields keyed by Freshsales internal field name.
integer ("1" | "2")
Pricing type, allowed only when prices are first added: 1 one-time or 2 subscription.
string
Unique product code.
integer
Parent product ID.
array
Complete pricing mutations. Existing entries are overwritten by supplied details; delete entries with id and destroy=true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPDATE_SALES_ACCOUNTUpdate standard or tenant-defined fields on a Freshsales sales account.

Input Parameters

object
required
Mutable fields using Freshsales wire names.
integer
required
Sales-account ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPDATE_SALES_ACCOUNT_TEAM_MEMBERSHIPSAdd, update, or remove team memberships for one Freshsales sales account. Requires an API-key connection; Freshworks does not authorize this operation through its available OAuth scopes.

Input Parameters

integer
required
Record ID whose team to change.
array
required
Team members to add, update, or remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPDATE_SALES_ACTIVITYUpdate selected fields on one existing Freshsales sales activity.

Input Parameters

object
required
One or more sales-activity fields to update.
integer
required
Freshsales sales-activity ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPDATE_TASKUpdate a Freshsales task through the single documented PUT path; set status=1 to mark it completed or status=0 to reopen it.

Input Parameters

object
required
One or more task fields; use status=1 to mark the task done.
integer
required
Freshsales task ID to update or mark done.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPLOAD_AND_ATTACH_FILEUpload a required file as multipart/form-data and attach it to one explicit Freshsales CRM record.

Input Parameters

object
required
File to upload and attach to the CRM record.
string
Optional provider-side display filename.
boolean
Whether the uploaded document is shared in Freshsales.
integer
required
Explicit ID of the target CRM record.
string ("Lead" | "Contact" | "SalesAccount" | "Deal" | "Product")
required
Freshsales type of the target record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPSERT_CONTACTCreate or update one Freshsales contact matched by a unique identifier and return the resulting contact.

Input Parameters

object
required
One or more contact fields to create or update, using Freshsales field names. Put custom fields under custom_field.
string
required
Freshsales contact field name used for matching. Use id or a field marked unique in this tenant’s contact form, such as emails, mobile_number, external_id, or a tenant-defined custom field.
string
required
Value of the selected unique identifier. Contact IDs may be strings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPSERT_DEALCreate or update a deal by one unique standard or tenant-defined field.

Input Parameters

object
required
Fields to create or update using Freshsales wire names.
string
required
Deal ID field (id) or another deal field configured as unique in the tenant.
string
required
Value to match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHSALES_UPSERT_SALES_ACCOUNTCreate or update a sales account by one unique standard or tenant-defined field.

Input Parameters

object
required
Fields to create or update using Freshsales wire names.
string
required
Unique sales-account field, such as name or external_id.
string
required
Value to match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not