/freshsales-entities | Type: Application | PCID required: Yes
Tools
freshsales_entities_add_contacts_to_marketing_list
Add contacts to a marketing list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
listId | integer | Yes | — | Numeric ID of the marketing list. |
ids | integer[] | Yes | — | IDs of contacts to add to the marketing list. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"listId": {
"type": "integer",
"description": "Numeric ID of the marketing list."
},
"ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of contacts to add to the marketing list."
}
},
"required": [
"PCID",
"listId",
"ids"
]
}
freshsales_entities_bulk_assign_contact_owner
Bulk reassign contact ownership Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
owner_id | integer | Yes | — | User ID of the new owner. |
selected_ids | integer[] | Yes | — | IDs of contacts to reassign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"owner_id": {
"type": "integer",
"description": "User ID of the new owner."
},
"selected_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of contacts to reassign."
}
},
"required": [
"PCID",
"owner_id",
"selected_ids"
]
}
freshsales_entities_bulk_destroy_contacts
Bulk destroy contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
selected_ids | integer[] | Yes | — | IDs of contacts to delete. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"selected_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of contacts to delete."
}
},
"required": [
"PCID",
"selected_ids"
]
}
freshsales_entities_bulk_destroy_deals
Bulk destroy deals Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
selected_ids | integer[] | Yes | — | IDs of deals to delete. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"selected_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of deals to delete."
}
},
"required": [
"PCID",
"selected_ids"
]
}
freshsales_entities_bulk_destroy_sales_accounts
Bulk destroy sales accounts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
selected_ids | integer[] | Yes | — | IDs of sales accounts to delete. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"selected_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of sales accounts to delete."
}
},
"required": [
"PCID",
"selected_ids"
]
}
freshsales_entities_bulk_upsert_contacts
Bulk upsert contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contacts | object[] | Yes | — | Array of contact upsert requests (max 100). Each item may use {emails, data: {…}} to match by email, or {id, data: {…}} to match by id. The ‘data’ object holds contact fields. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contacts": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of contact upsert requests (max 100). Each item may use {emails, data: {...}} to match by email, or {id, data: {...}} to match by id. The 'data' object holds contact fields."
}
},
"required": [
"PCID",
"contacts"
]
}
freshsales_entities_bulk_upsert_deals
Bulk upsert deals Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deals | object[] | Yes | — | Array of deal upsert requests (max 100). Each item: {name OR id, data: {…}}. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deals": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of deal upsert requests (max 100). Each item: {name OR id, data: {...}}."
}
},
"required": [
"PCID",
"deals"
]
}
freshsales_entities_bulk_upsert_sales_accounts
Bulk upsert sales accounts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sales_accounts | object[] | Yes | — | Array of sales-account upsert requests (max 100). Each item uses {name OR id, data: {…}}. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sales_accounts": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of sales-account upsert requests (max 100). Each item uses {name OR id, data: {...}}."
}
},
"required": [
"PCID",
"sales_accounts"
]
}
freshsales_entities_clone_contact
Clone a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the contact to clone. |
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 contact to clone."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_entities_clone_deal
Clone a deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the deal to clone. |
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 to clone."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_entities_clone_sales_account
Clone a sales account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the sales account to clone. |
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 sales account to clone."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_entities_create_contact
Create a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contact | object | Yes | — | Contact fields. Common keys: first_name, last_name, emails (array of {value, is_primary}), mobile_number, work_number, job_title, owner_id, sales_account_id, lead_source_id, lifecycle_stage_id, territory_id, subscription_status, address, city, state, country, zipcode, time_zone, tags, keyword, facebook, twitter, linkedin, custom_field (object of cf_* custom fields). Only first_name or last_name is typically required. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contact": {
"type": "object",
"description": "Contact fields. Common keys: first_name, last_name, emails (array of {value, is_primary}), mobile_number, work_number, job_title, owner_id, sales_account_id, lead_source_id, lifecycle_stage_id, territory_id, subscription_status, address, city, state, country, zipcode, time_zone, tags, keyword, facebook, twitter, linkedin, custom_field (object of cf_* custom fields). Only first_name or last_name is typically required."
}
},
"required": [
"PCID",
"contact"
]
}
freshsales_entities_create_deal
Create a deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deal | object | Yes | — | Deal fields. Common keys: name (required), amount (required), sales_account_id, owner_id, deal_stage_id, deal_pipeline_id, deal_type_id, deal_reason_id, currency_id, expected_close, probability, lead_source_id, campaign_id, territory_id, contacts_ids (array), custom_field (object of cf_* keys). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deal": {
"type": "object",
"description": "Deal fields. Common keys: name (required), amount (required), sales_account_id, owner_id, deal_stage_id, deal_pipeline_id, deal_type_id, deal_reason_id, currency_id, expected_close, probability, lead_source_id, campaign_id, territory_id, contacts_ids (array), custom_field (object of cf_* keys)."
}
},
"required": [
"PCID",
"deal"
]
}
freshsales_entities_create_marketing_list
Create a marketing list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | Optional description of the list. |
name | string | Yes | — | Name of the marketing list. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": "string",
"description": "Optional description of the list."
},
"name": {
"type": "string",
"description": "Name of the marketing list."
}
},
"required": [
"PCID",
"name"
]
}
freshsales_entities_create_sales_account
Create a sales account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sales_account | object | Yes | — | Sales account fields. Common keys: name (required), website, owner_id, phone, industry_type_id, business_type_id, number_of_employees, annual_revenue, address, city, state, country, zipcode, facebook, twitter, linkedin, tags, parent_sales_account_id, custom_field (object of cf_* keys). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sales_account": {
"type": "object",
"description": "Sales account fields. Common keys: name (required), website, owner_id, phone, industry_type_id, business_type_id, number_of_employees, annual_revenue, address, city, state, country, zipcode, facebook, twitter, linkedin, tags, parent_sales_account_id, custom_field (object of cf_* keys)."
}
},
"required": [
"PCID",
"sales_account"
]
}
freshsales_entities_delete_contact
Soft-delete a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the contact to soft-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 contact to soft-delete."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_entities_delete_deal
Soft-delete a deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the deal to soft-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 deal to soft-delete."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_entities_delete_sales_account
Soft-delete a sales account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the sales account to soft-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 sales account to soft-delete."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_entities_forget_contact
Permanently delete (forget) a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the contact to permanently 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 contact to permanently delete."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_entities_forget_deal
Permanently delete (forget) a deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the deal to permanently 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 deal to permanently delete."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_entities_forget_sales_account
Permanently delete (forget) a sales account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the sales account to permanently 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 sales account to permanently delete."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_entities_get_contact
Get a contact by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the contact. |
include | string | No | — | Comma-separated list of side-loaded associations. Supported values include: creater, owner, updater, salesActivities, phoneNumbers, emails, tasks, appointments, notes. |
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 contact."
},
"include": {
"type": "string",
"description": "Comma-separated list of side-loaded associations. Supported values include: `creater`, `owner`, `updater`, `salesActivities`, `phoneNumbers`, `emails`, `tasks`, `appointments`, `notes`."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_entities_get_deal
Get a deal by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the deal. |
include | string | No | — | Comma-separated list of associated resources to side-load into the response. Valid values depend on the parent entity (e.g., for contacts: “creater,owner,updater,salesActivities,phoneNumbers,emails,tasks,appointments,notes”). |
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."
},
"include": {
"type": "string",
"description": "Comma-separated list of associated resources to side-load into the response. Valid values depend on the parent entity (e.g., for contacts: \"creater,owner,updater,salesActivities,phoneNumbers,emails,tasks,appointments,notes\")."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_entities_get_sales_account
Get a sales account by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the sales account. |
include | string | No | — | Comma-separated list of associated resources to side-load into the response. Valid values depend on the parent entity (e.g., for contacts: “creater,owner,updater,salesActivities,phoneNumbers,emails,tasks,appointments,notes”). |
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 sales account."
},
"include": {
"type": "string",
"description": "Comma-separated list of associated resources to side-load into the response. Valid values depend on the parent entity (e.g., for contacts: \"creater,owner,updater,salesActivities,phoneNumbers,emails,tasks,appointments,notes\")."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_entities_list_contact_activities
List activities on a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the contact. |
page | integer | No | — | Page number for paginated results (default 1). |
activity_type | string | No | — | Optional activity type to filter by (e.g., “Email”, “Call”, “Meeting”). Exact valid values depend on your account configuration. |
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 contact."
},
"page": {
"type": "integer",
"description": "Page number for paginated results (default 1)."
},
"activity_type": {
"type": "string",
"description": "Optional activity type to filter by (e.g., \"Email\", \"Call\", \"Meeting\"). Exact valid values depend on your account configuration."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_entities_list_contact_fields
List contact field definitionsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_entities_list_contact_filters
List available contact views/filtersShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_entities_list_contacts_by_view
List contacts in a view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
viewId | integer | Yes | — | The numeric ID of the saved contact view/filter. |
page | integer | No | — | Page number for paginated results (default 1). |
sort | string | No | — | Field name to sort the result set by (e.g., “created_at”, “updated_at”, “display_name”). |
sort_type | string | No | — | Sort direction — ascending (“asc”) or descending (“desc”). |
include | string | No | — | Comma-separated list of associated resources to side-load into the response. Valid values depend on the parent entity (e.g., for contacts: “creater,owner,updater,salesActivities,phoneNumbers,emails,tasks,appointments,notes”). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "integer",
"description": "The numeric ID of the saved contact 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 (e.g., \"created_at\", \"updated_at\", \"display_name\")."
},
"sort_type": {
"type": "string",
"description": "Sort direction — ascending (\"asc\") or descending (\"desc\").",
"enum": [
"asc",
"desc"
]
},
"include": {
"type": "string",
"description": "Comma-separated list of associated resources to side-load into the response. Valid values depend on the parent entity (e.g., for contacts: \"creater,owner,updater,salesActivities,phoneNumbers,emails,tasks,appointments,notes\")."
}
},
"required": [
"PCID",
"viewId"
]
}
freshsales_entities_list_contacts_in_marketing_list
List contacts in a marketing list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the marketing list. |
page | integer | No | — | Page number for paginated results (default 1). |
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 marketing list."
},
"page": {
"type": "integer",
"description": "Page number for paginated results (default 1)."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_entities_list_deal_fields
List deal field definitionsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_entities_list_deal_filters
List available deal views/filtersShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_entities_list_deals_by_view
List deals in a view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
viewId | integer | Yes | — | The numeric ID of the saved deal view/filter. |
page | integer | No | — | Page number for paginated results (default 1). |
sort | string | No | — | Field name to sort the result set by (e.g., “created_at”, “updated_at”, “display_name”). |
sort_type | string | No | — | Sort direction — ascending (“asc”) or descending (“desc”). |
include | string | No | — | Comma-separated list of associated resources to side-load into the response. Valid values depend on the parent entity (e.g., for contacts: “creater,owner,updater,salesActivities,phoneNumbers,emails,tasks,appointments,notes”). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "integer",
"description": "The numeric ID of the saved deal 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 (e.g., \"created_at\", \"updated_at\", \"display_name\")."
},
"sort_type": {
"type": "string",
"description": "Sort direction — ascending (\"asc\") or descending (\"desc\").",
"enum": [
"asc",
"desc"
]
},
"include": {
"type": "string",
"description": "Comma-separated list of associated resources to side-load into the response. Valid values depend on the parent entity (e.g., for contacts: \"creater,owner,updater,salesActivities,phoneNumbers,emails,tasks,appointments,notes\")."
}
},
"required": [
"PCID",
"viewId"
]
}
freshsales_entities_list_marketing_lists
List all marketing lists Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for paginated results (default 1). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number for paginated results (default 1)."
}
},
"required": [
"PCID"
]
}
freshsales_entities_list_sales_account_fields
List sales account field definitionsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_entities_list_sales_account_filters
List available sales account views/filtersShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshsales_entities_list_sales_accounts_by_view
List sales accounts in a view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
viewId | integer | Yes | — | The numeric ID of the saved sales account view/filter. |
page | integer | No | — | Page number for paginated results (default 1). |
sort | string | No | — | Field name to sort the result set by (e.g., “created_at”, “updated_at”, “display_name”). |
sort_type | string | No | — | Sort direction — ascending (“asc”) or descending (“desc”). |
include | string | No | — | Comma-separated list of associated resources to side-load into the response. Valid values depend on the parent entity (e.g., for contacts: “creater,owner,updater,salesActivities,phoneNumbers,emails,tasks,appointments,notes”). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"viewId": {
"type": "integer",
"description": "The numeric ID of the saved sales account 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 (e.g., \"created_at\", \"updated_at\", \"display_name\")."
},
"sort_type": {
"type": "string",
"description": "Sort direction — ascending (\"asc\") or descending (\"desc\").",
"enum": [
"asc",
"desc"
]
},
"include": {
"type": "string",
"description": "Comma-separated list of associated resources to side-load into the response. Valid values depend on the parent entity (e.g., for contacts: \"creater,owner,updater,salesActivities,phoneNumbers,emails,tasks,appointments,notes\")."
}
},
"required": [
"PCID",
"viewId"
]
}
freshsales_entities_manage_contact_team_members
Add or remove team members on a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the contact. |
team_users | object[] | Yes | — | Array of team member updates. Each item: {user_id, designation_id}. To remove a team member, include {user_id, designation_id, _destroy: true}. |
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 contact."
},
"team_users": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of team member updates. Each item: {user_id, designation_id}. To remove a team member, include {user_id, designation_id, _destroy: true}."
}
},
"required": [
"PCID",
"id",
"team_users"
]
}
freshsales_entities_manage_deal_team_members
Add or remove team members on a deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the deal. |
team_users | object[] | Yes | — | Array of team member updates. |
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."
},
"team_users": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of team member updates."
}
},
"required": [
"PCID",
"id",
"team_users"
]
}
freshsales_entities_manage_sales_account_team_members
Add or remove team members on a sales account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the sales account. |
team_users | object[] | Yes | — | Array of team member updates. Same shape as manageContactTeamMembers. |
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 sales account."
},
"team_users": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of team member updates. Same shape as manageContactTeamMembers."
}
},
"required": [
"PCID",
"id",
"team_users"
]
}
freshsales_entities_move_contacts_between_marketing_lists
Move contacts between marketing lists Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
listId | integer | Yes | — | Numeric ID of the source marketing list. |
ids | integer[] | Yes | — | IDs of contacts to move. |
target_list_id | integer | Yes | — | ID of the destination marketing list. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"listId": {
"type": "integer",
"description": "Numeric ID of the source marketing list."
},
"ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of contacts to move."
},
"target_list_id": {
"type": "integer",
"description": "ID of the destination marketing list."
}
},
"required": [
"PCID",
"listId",
"ids",
"target_list_id"
]
}
freshsales_entities_remove_contacts_from_marketing_list
Remove contacts from a marketing list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
listId | integer | Yes | — | Numeric ID of the marketing list. |
ids | integer[] | Yes | — | IDs of contacts to remove from the marketing list. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"listId": {
"type": "integer",
"description": "Numeric ID of the marketing list."
},
"ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of contacts to remove from the marketing list."
}
},
"required": [
"PCID",
"listId",
"ids"
]
}
freshsales_entities_update_contact
Update a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the contact to update. |
contact | object | Yes | — | Partial contact fields to update. Any key accepted by createContact is accepted here, plus custom_field (object of cf_* keys). |
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 contact to update."
},
"contact": {
"type": "object",
"description": "Partial contact fields to update. Any key accepted by createContact is accepted here, plus custom_field (object of cf_* keys)."
}
},
"required": [
"PCID",
"id",
"contact"
]
}
freshsales_entities_update_deal
Update a deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the deal. |
deal | object | Yes | — | Partial deal 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 deal."
},
"deal": {
"type": "object",
"description": "Partial deal fields to update."
}
},
"required": [
"PCID",
"id",
"deal"
]
}
freshsales_entities_update_marketing_list
Update a marketing list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the marketing list. |
description | string | No | — | New description. |
name | string | No | — | New name for the marketing list. |
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 marketing list."
},
"description": {
"type": "string",
"description": "New description."
},
"name": {
"type": "string",
"description": "New name for the marketing list."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_entities_update_sales_account
Update a sales account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Numeric ID of the sales account. |
sales_account | object | Yes | — | Partial sales-account 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 sales account."
},
"sales_account": {
"type": "object",
"description": "Partial sales-account fields to update."
}
},
"required": [
"PCID",
"id",
"sales_account"
]
}
freshsales_entities_upsert_contact
Upsert a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contact | object | Yes | — | Contact fields. Same shape as createContact payload. |
unique_identifier | object | Yes | — | Unique field used to locate an existing contact. Typical shape: {emails: ‘value@example.com’} or {mobile_number: ‘+15551234567’}. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contact": {
"type": "object",
"description": "Contact fields. Same shape as createContact payload."
},
"unique_identifier": {
"type": "object",
"description": "Unique field used to locate an existing contact. Typical shape: {emails: 'value@example.com'} or {mobile_number: '+15551234567'}."
}
},
"required": [
"PCID",
"contact",
"unique_identifier"
]
}
freshsales_entities_upsert_deal
Upsert a deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deal | object | Yes | — | Deal fields. Same shape as createDeal payload. |
unique_identifier | object | Yes | — | Unique field used to match the deal. E.g., {name: ’…‘}. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deal": {
"type": "object",
"description": "Deal fields. Same shape as createDeal payload."
},
"unique_identifier": {
"type": "object",
"description": "Unique field used to match the deal. E.g., {name: '...'}."
}
},
"required": [
"PCID",
"deal",
"unique_identifier"
]
}
freshsales_entities_upsert_sales_account
Upsert a sales account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sales_account | object | Yes | — | Sales account fields. Same shape as createSalesAccount payload. |
unique_identifier | object | Yes | — | Unique field used to match. Typical shape: {name: ’…’} or {website: ’…’}. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sales_account": {
"type": "object",
"description": "Sales account fields. Same shape as createSalesAccount payload."
},
"unique_identifier": {
"type": "object",
"description": "Unique field used to match. Typical shape: {name: '...'} or {website: '...'}."
}
},
"required": [
"PCID",
"sales_account",
"unique_identifier"
]
}