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

# freshsales-entities

> Freshsales Entities

**Server path:** `/freshsales-entities` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                                      | Description                                   |
| ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
| [`freshsales_entities_add_contacts_to_marketing_list`](#freshsales_entities_add_contacts_to_marketing_list)               | Add contacts to a marketing list              |
| [`freshsales_entities_bulk_assign_contact_owner`](#freshsales_entities_bulk_assign_contact_owner)                         | Bulk reassign contact ownership               |
| [`freshsales_entities_bulk_destroy_contacts`](#freshsales_entities_bulk_destroy_contacts)                                 | Bulk destroy contacts                         |
| [`freshsales_entities_bulk_destroy_deals`](#freshsales_entities_bulk_destroy_deals)                                       | Bulk destroy deals                            |
| [`freshsales_entities_bulk_destroy_sales_accounts`](#freshsales_entities_bulk_destroy_sales_accounts)                     | Bulk destroy sales accounts                   |
| [`freshsales_entities_bulk_upsert_contacts`](#freshsales_entities_bulk_upsert_contacts)                                   | Bulk upsert contacts                          |
| [`freshsales_entities_bulk_upsert_deals`](#freshsales_entities_bulk_upsert_deals)                                         | Bulk upsert deals                             |
| [`freshsales_entities_bulk_upsert_sales_accounts`](#freshsales_entities_bulk_upsert_sales_accounts)                       | Bulk upsert sales accounts                    |
| [`freshsales_entities_clone_contact`](#freshsales_entities_clone_contact)                                                 | Clone a contact                               |
| [`freshsales_entities_clone_deal`](#freshsales_entities_clone_deal)                                                       | Clone a deal                                  |
| [`freshsales_entities_clone_sales_account`](#freshsales_entities_clone_sales_account)                                     | Clone a sales account                         |
| [`freshsales_entities_create_contact`](#freshsales_entities_create_contact)                                               | Create a contact                              |
| [`freshsales_entities_create_deal`](#freshsales_entities_create_deal)                                                     | Create a deal                                 |
| [`freshsales_entities_create_marketing_list`](#freshsales_entities_create_marketing_list)                                 | Create a marketing list                       |
| [`freshsales_entities_create_sales_account`](#freshsales_entities_create_sales_account)                                   | Create a sales account                        |
| [`freshsales_entities_delete_contact`](#freshsales_entities_delete_contact)                                               | Soft-delete a contact                         |
| [`freshsales_entities_delete_deal`](#freshsales_entities_delete_deal)                                                     | Soft-delete a deal                            |
| [`freshsales_entities_delete_sales_account`](#freshsales_entities_delete_sales_account)                                   | Soft-delete a sales account                   |
| [`freshsales_entities_forget_contact`](#freshsales_entities_forget_contact)                                               | Permanently delete (forget) a contact         |
| [`freshsales_entities_forget_deal`](#freshsales_entities_forget_deal)                                                     | Permanently delete (forget) a deal            |
| [`freshsales_entities_forget_sales_account`](#freshsales_entities_forget_sales_account)                                   | Permanently delete (forget) a sales account   |
| [`freshsales_entities_get_contact`](#freshsales_entities_get_contact)                                                     | Get a contact by ID                           |
| [`freshsales_entities_get_deal`](#freshsales_entities_get_deal)                                                           | Get a deal by ID                              |
| [`freshsales_entities_get_sales_account`](#freshsales_entities_get_sales_account)                                         | Get a sales account by ID                     |
| [`freshsales_entities_list_contact_activities`](#freshsales_entities_list_contact_activities)                             | List activities on a contact                  |
| [`freshsales_entities_list_contact_fields`](#freshsales_entities_list_contact_fields)                                     | List contact field definitions                |
| [`freshsales_entities_list_contact_filters`](#freshsales_entities_list_contact_filters)                                   | List available contact views/filters          |
| [`freshsales_entities_list_contacts_by_view`](#freshsales_entities_list_contacts_by_view)                                 | List contacts in a view                       |
| [`freshsales_entities_list_contacts_in_marketing_list`](#freshsales_entities_list_contacts_in_marketing_list)             | List contacts in a marketing list             |
| [`freshsales_entities_list_deal_fields`](#freshsales_entities_list_deal_fields)                                           | List deal field definitions                   |
| [`freshsales_entities_list_deal_filters`](#freshsales_entities_list_deal_filters)                                         | List available deal views/filters             |
| [`freshsales_entities_list_deals_by_view`](#freshsales_entities_list_deals_by_view)                                       | List deals in a view                          |
| [`freshsales_entities_list_marketing_lists`](#freshsales_entities_list_marketing_lists)                                   | List all marketing lists                      |
| [`freshsales_entities_list_sales_account_fields`](#freshsales_entities_list_sales_account_fields)                         | List sales account field definitions          |
| [`freshsales_entities_list_sales_account_filters`](#freshsales_entities_list_sales_account_filters)                       | List available sales account views/filters    |
| [`freshsales_entities_list_sales_accounts_by_view`](#freshsales_entities_list_sales_accounts_by_view)                     | List sales accounts in a view                 |
| [`freshsales_entities_manage_contact_team_members`](#freshsales_entities_manage_contact_team_members)                     | Add or remove team members on a contact       |
| [`freshsales_entities_manage_deal_team_members`](#freshsales_entities_manage_deal_team_members)                           | Add or remove team members on a deal          |
| [`freshsales_entities_manage_sales_account_team_members`](#freshsales_entities_manage_sales_account_team_members)         | Add or remove team members on a sales account |
| [`freshsales_entities_move_contacts_between_marketing_lists`](#freshsales_entities_move_contacts_between_marketing_lists) | Move contacts between marketing lists         |
| [`freshsales_entities_remove_contacts_from_marketing_list`](#freshsales_entities_remove_contacts_from_marketing_list)     | Remove contacts from a marketing list         |
| [`freshsales_entities_update_contact`](#freshsales_entities_update_contact)                                               | Update a contact                              |
| [`freshsales_entities_update_deal`](#freshsales_entities_update_deal)                                                     | Update a deal                                 |
| [`freshsales_entities_update_marketing_list`](#freshsales_entities_update_marketing_list)                                 | Update a marketing list                       |
| [`freshsales_entities_update_sales_account`](#freshsales_entities_update_sales_account)                                   | Update a sales account                        |
| [`freshsales_entities_upsert_contact`](#freshsales_entities_upsert_contact)                                               | Upsert a contact                              |
| [`freshsales_entities_upsert_deal`](#freshsales_entities_upsert_deal)                                                     | Upsert a deal                                 |
| [`freshsales_entities_upsert_sales_account`](#freshsales_entities_upsert_sales_account)                                   | Upsert a sales account                        |

***

## 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## freshsales\_entities\_bulk\_destroy\_contacts

Bulk destroy contacts

**Parameters:**

| Parameter      | Type       | Required | Default | Description                |
| -------------- | ---------- | -------- | ------- | -------------------------- |
| `selected_ids` | integer\[] | Yes      | —       | IDs of contacts to delete. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## freshsales\_entities\_bulk\_destroy\_deals

Bulk destroy deals

**Parameters:**

| Parameter      | Type       | Required | Default | Description             |
| -------------- | ---------- | -------- | ------- | ----------------------- |
| `selected_ids` | integer\[] | Yes      | —       | IDs of deals to delete. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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: \{...}}. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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: \{...}}. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## freshsales\_entities\_clone\_contact

Clone a contact

**Parameters:**

| Parameter | Type    | Required | Default | Description                         |
| --------- | ------- | -------- | ------- | ----------------------------------- |
| `id`      | integer | Yes      | —       | Numeric ID of the contact to clone. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## freshsales\_entities\_clone\_deal

Clone a deal

**Parameters:**

| Parameter | Type    | Required | Default | Description                      |
| --------- | ------- | -------- | ------- | -------------------------------- |
| `id`      | integer | Yes      | —       | Numeric ID of the deal to clone. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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.       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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`. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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"). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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"). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## freshsales\_entities\_list\_contact\_fields

List contact field definitions

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## freshsales\_entities\_list\_contact\_filters

List available contact views/filters

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## 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"). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## freshsales\_entities\_list\_deal\_fields

List deal field definitions

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## freshsales\_entities\_list\_deal\_filters

List available deal views/filters

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## 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"). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## freshsales\_entities\_list\_sales\_account\_fields

List sales account field definitions

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## freshsales\_entities\_list\_sales\_account\_filters

List available sales account views/filters

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## 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"). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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}. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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.    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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.  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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](mailto:value@example.com)'} or \{mobile\_number: '+15551234567'}. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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: '...'}. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>

***

## 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: '...'}. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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"
    ]
  }
  ```
</Expandable>