/freshsales-utilities | Type: Application | PCID required: Yes
Tools
freshsales_utilities_clone_custom_module_record
Clone a custom module record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entityName | string | Yes | — | The API name of the custom module. |
id | integer | Yes | — | Numeric ID of the record to clone. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entityName": {
"type": "string",
"description": "The API name of the custom module."
},
"id": {
"type": "integer",
"description": "Numeric ID of the record to clone."
}
},
"required": [
"PCID",
"entityName",
"id"
]
}
freshsales_utilities_create_custom_field
Create a custom field on a module Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entityType | string | Yes | — | The entity type to add the field to (e.g., ‘contacts’, ‘sales_accounts’, ‘deals’, or a custom module API name). |
formId | integer | Yes | — | Numeric ID of the form to add the field to. Use listModuleFields to discover form IDs. |
field | object | Yes | — | Field definition. Common keys: name (required), label (required), type (required — e.g., ‘text’, ‘number’, ‘dropdown’, ‘date’, ‘checkbox’), required (boolean), choices (array, for dropdown fields). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entityType": {
"type": "string",
"description": "The entity type to add the field to (e.g., 'contacts', 'sales_accounts', 'deals', or a custom module API name)."
},
"formId": {
"type": "integer",
"description": "Numeric ID of the form to add the field to. Use `listModuleFields` to discover form IDs."
},
"field": {
"type": "object",
"description": "Field definition. Common keys: name (required), label (required), type (required — e.g., 'text', 'number', 'dropdown', 'date', 'checkbox'), required (boolean), choices (array, for dropdown fields)."
}
},
"required": [
"PCID",
"entityType",
"formId",
"field"
]
}
freshsales_utilities_create_custom_module
Create a custom module definition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
module_customization | object | Yes | — | Module definition fields. Common keys: name (required), label, label_in_plural, icon_name, description. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"module_customization": {
"type": "object",
"description": "Module definition fields. Common keys: name (required), label, label_in_plural, icon_name, description."
}
},
"required": [
"PCID",
"module_customization"
]
}
freshsales_utilities_create_custom_module_record
Create a record in a custom module Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entityName | string | Yes | — | The API name of the custom module (e.g., ‘cm_vehicles’). Use listCustomModules to discover available names. |
custom_module | object | Yes | — | Record fields. Keys depend on the custom module’s field definitions (e.g., cf_make, cf_model, cf_year). Use listModuleFields to discover available fields. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entityName": {
"type": "string",
"description": "The API name of the custom module (e.g., 'cm_vehicles'). Use `listCustomModules` to discover available names."
},
"custom_module": {
"type": "object",
"description": "Record fields. Keys depend on the custom module's field definitions (e.g., cf_make, cf_model, cf_year). Use `listModuleFields` to discover available fields."
}
},
"required": [
"PCID",
"entityName",
"custom_module"
]
}
freshsales_utilities_delete_custom_module
Delete a custom module definition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the custom module definition to delete. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Numeric ID of the custom module definition to delete."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_utilities_delete_custom_module_record
Delete a custom module record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entityName | string | Yes | — | The API name of the custom module. |
id | integer | Yes | — | Numeric ID of the record to delete. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entityName": {
"type": "string",
"description": "The API name of the custom module."
},
"id": {
"type": "integer",
"description": "Numeric ID of the record to delete."
}
},
"required": [
"PCID",
"entityName",
"id"
]
}
freshsales_utilities_forget_custom_module_record
Permanently delete (forget) a custom module record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entityName | string | Yes | — | The API name of the custom module. |
id | integer | Yes | — | Numeric ID of the record to permanently delete. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entityName": {
"type": "string",
"description": "The API name of the custom module."
},
"id": {
"type": "integer",
"description": "Numeric ID of the record to permanently delete."
}
},
"required": [
"PCID",
"entityName",
"id"
]
}
freshsales_utilities_get_custom_module_record
Get a custom module record by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entityName | string | Yes | — | The API name of the custom module. |
id | integer | Yes | — | Numeric ID of the record. |
include | string | No | — | Comma-separated list of associated resources to side-load. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entityName": {
"type": "string",
"description": "The API name of the custom module."
},
"id": {
"type": "integer",
"description": "Numeric ID of the record."
},
"include": {
"type": "string",
"description": "Comma-separated list of associated resources to side-load."
}
},
"required": [
"PCID",
"entityName",
"id"
]
}
freshsales_utilities_get_job_status
Get the status of an async job Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the job (as returned by a prior bulk operation). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Numeric ID of the job (as returned by a prior bulk operation)."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_utilities_list_business_types
List business typesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_utilities_list_campaigns
List campaignsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_utilities_list_contact_statuses
List contact statusesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_utilities_list_currencies
List configured currenciesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_utilities_list_custom_module_records_by_view
List custom module records in a view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entityName | string | Yes | — | The API name of the custom module. |
viewId | integer | Yes | — | The numeric ID of the saved view/filter. |
page | integer | No | — | Page number for paginated results (default 1). |
sort | string | No | — | Field name to sort the result set by. |
sort_type | string | No | — | Sort direction. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entityName": {
"type": "string",
"description": "The API name of the custom module."
},
"viewId": {
"type": "integer",
"description": "The numeric ID of the saved view/filter."
},
"page": {
"type": "integer",
"description": "Page number for paginated results (default 1)."
},
"sort": {
"type": "string",
"description": "Field name to sort the result set by."
},
"sort_type": {
"type": "string",
"description": "Sort direction.",
"enum": [
"asc",
"desc"
]
}
},
"required": [
"PCID",
"entityName",
"viewId"
]
}
freshsales_utilities_list_custom_modules
List all custom module definitionsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_utilities_list_deal_payment_statuses
List deal payment statusesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_utilities_list_deal_reasons
List deal (won/lost) reasonsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_utilities_list_deal_stages
List deal stagesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_utilities_list_deal_stages_by_pipeline
List deal stages for a pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the deal pipeline. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Numeric ID of the deal pipeline."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_utilities_list_deal_types
List deal typesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_utilities_list_designations
List designationsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_utilities_list_industry_types
List industry typesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_utilities_list_lead_sources
List lead sourcesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_utilities_list_lifecycle_stages
List lifecycle stagesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_utilities_list_module_fields
List field definitions for a module Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entityType | string | Yes | — | The entity type (e.g., ‘contacts’, ‘sales_accounts’, ‘deals’, or a custom module API name). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entityType": {
"type": "string",
"description": "The entity type (e.g., 'contacts', 'sales_accounts', 'deals', or a custom module API name)."
}
},
"required": [
"PCID",
"entityType"
]
}
freshsales_utilities_list_owners
List available ownersShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_utilities_list_sales_activity_outcomes
List sales activity outcomesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_utilities_list_sales_activity_types
List sales activity typesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_utilities_list_territories
List territoriesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_utilities_lookup
Look up records by a specific field value Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | Yes | — | The value to match against the field. |
f | string | Yes | — | The name of the field to match on (e.g., “email”, “website”). |
entities | string | Yes | — | Comma-separated list of entity types to search across. Valid values: contact, sales_account, deal. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q": {
"type": "string",
"description": "The value to match against the field."
},
"f": {
"type": "string",
"description": "The name of the field to match on (e.g., \"email\", \"website\")."
},
"entities": {
"type": "string",
"description": "Comma-separated list of entity types to search across. Valid values: `contact`, `sales_account`, `deal`."
}
},
"required": [
"PCID",
"q",
"f",
"entities"
]
}
freshsales_utilities_search
Full-text search across CRM entities Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | Yes | — | The search query string. |
include | string | Yes | — | Comma-separated list of entity types to search across. Valid values: contact, sales_account, deal, user, lead. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q": {
"type": "string",
"description": "The search query string."
},
"include": {
"type": "string",
"description": "Comma-separated list of entity types to search across. Valid values: `contact`, `sales_account`, `deal`, `user`, `lead`."
}
},
"required": [
"PCID",
"q",
"include"
]
}
freshsales_utilities_update_custom_module
Update a custom module definition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the custom module definition. |
module_customization | object | Yes | — | Partial module definition fields to update. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Numeric ID of the custom module definition."
},
"module_customization": {
"type": "object",
"description": "Partial module definition fields to update."
}
},
"required": [
"PCID",
"id",
"module_customization"
]
}
freshsales_utilities_update_custom_module_record
Update a custom module record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entityName | string | Yes | — | The API name of the custom module. |
id | integer | Yes | — | Numeric ID of the record to update. |
custom_module | object | Yes | — | Partial record fields to update. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entityName": {
"type": "string",
"description": "The API name of the custom module."
},
"id": {
"type": "integer",
"description": "Numeric ID of the record to update."
},
"custom_module": {
"type": "object",
"description": "Partial record fields to update."
}
},
"required": [
"PCID",
"entityName",
"id",
"custom_module"
]
}