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

> Freshsales Activities

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

## Tools

| Tool                                                                                                                    | Description                           |
| ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| [`freshsales_activities_create_appointment`](#freshsales_activities_create_appointment)                                 | Create an appointment                 |
| [`freshsales_activities_create_document_link`](#freshsales_activities_create_document_link)                             | Attach a URL link to a CRM record     |
| [`freshsales_activities_create_file`](#freshsales_activities_create_file)                                               | Attach a file to a CRM record         |
| [`freshsales_activities_create_note`](#freshsales_activities_create_note)                                               | Create a note                         |
| [`freshsales_activities_create_sales_activity`](#freshsales_activities_create_sales_activity)                           | Create a sales activity               |
| [`freshsales_activities_create_task`](#freshsales_activities_create_task)                                               | Create a task                         |
| [`freshsales_activities_delete_appointment`](#freshsales_activities_delete_appointment)                                 | Delete an appointment                 |
| [`freshsales_activities_delete_note`](#freshsales_activities_delete_note)                                               | Delete a note                         |
| [`freshsales_activities_delete_sales_activity`](#freshsales_activities_delete_sales_activity)                           | Delete a sales activity               |
| [`freshsales_activities_delete_task`](#freshsales_activities_delete_task)                                               | Delete a task                         |
| [`freshsales_activities_get_appointment`](#freshsales_activities_get_appointment)                                       | Get an appointment by ID              |
| [`freshsales_activities_get_sales_activity`](#freshsales_activities_get_sales_activity)                                 | Get a sales activity by ID            |
| [`freshsales_activities_get_task`](#freshsales_activities_get_task)                                                     | Get a task by ID                      |
| [`freshsales_activities_list_appointments`](#freshsales_activities_list_appointments)                                   | List appointments                     |
| [`freshsales_activities_list_contact_document_associations`](#freshsales_activities_list_contact_document_associations) | List files and links for a contact    |
| [`freshsales_activities_list_sales_activities`](#freshsales_activities_list_sales_activities)                           | List sales activities                 |
| [`freshsales_activities_list_sales_activity_fields`](#freshsales_activities_list_sales_activity_fields)                 | List sales activity field definitions |
| [`freshsales_activities_list_tasks`](#freshsales_activities_list_tasks)                                                 | List tasks                            |
| [`freshsales_activities_log_phone_call`](#freshsales_activities_log_phone_call)                                         | Log a phone call                      |
| [`freshsales_activities_update_appointment`](#freshsales_activities_update_appointment)                                 | Update an appointment                 |
| [`freshsales_activities_update_note`](#freshsales_activities_update_note)                                               | Update a note                         |
| [`freshsales_activities_update_sales_activity`](#freshsales_activities_update_sales_activity)                           | Update a sales activity               |
| [`freshsales_activities_update_task`](#freshsales_activities_update_task)                                               | Update a task                         |

***

## freshsales\_activities\_create\_appointment

Create an appointment

**Parameters:**

| Parameter     | Type   | Required | Default | Description                                                                                                                                                                                                                                                                                    |
| ------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `appointment` | object | Yes      | —       | Appointment fields. Common keys: title (required), description, from\_date, end\_date, location, is\_allday, time\_zone, outcome\_id, conference\_id, creater\_id, owner\_id, targetable\_type, targetable\_id, appointment\_attendees\_attributes (array of \{attendee\_type, attendee\_id}). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "appointment": {
        "type": "object",
        "description": "Appointment fields. Common keys: title (required), description, from_date, end_date, location, is_allday, time_zone, outcome_id, conference_id, creater_id, owner_id, targetable_type, targetable_id, appointment_attendees_attributes (array of {attendee_type, attendee_id})."
      }
    },
    "required": [
      "PCID",
      "appointment"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_create\_document\_link

Attach a URL link to a CRM record

**Parameters:**

| Parameter       | Type   | Required | Default | Description                                                                                                                                                                                |
| --------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `document_link` | object | Yes      | —       | Link fields. Common keys: url (required), targetable\_type ('Contact', 'SalesAccount', or 'Deal'), targetable\_id (integer — ID of the record to attach to), name (optional display name). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "document_link": {
        "type": "object",
        "description": "Link fields. Common keys: url (required), targetable_type ('Contact', 'SalesAccount', or 'Deal'), targetable_id (integer — ID of the record to attach to), name (optional display name)."
      }
    },
    "required": [
      "PCID",
      "document_link"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_create\_file

Attach a file to a CRM record

**Parameters:**

| Parameter  | Type   | Required | Default | Description                                                                                                                                                                                  |
| ---------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `document` | object | Yes      | —       | File fields. Common keys: name (required), url (required — the file URL), targetable\_type ('Contact', 'SalesAccount', or 'Deal'), targetable\_id (integer — ID of the record to attach to). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "document": {
        "type": "object",
        "description": "File fields. Common keys: name (required), url (required — the file URL), targetable_type ('Contact', 'SalesAccount', or 'Deal'), targetable_id (integer — ID of the record to attach to)."
      }
    },
    "required": [
      "PCID",
      "document"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_create\_note

Create a note

**Parameters:**

| Parameter | Type   | Required | Default | Description                                                                                                                             |
| --------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `note`    | object | Yes      | —       | Note fields. Common keys: description (required), targetable\_type ('Contact', 'SalesAccount', or 'Deal'), targetable\_id, creater\_id. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "note": {
        "type": "object",
        "description": "Note fields. Common keys: description (required), targetable_type ('Contact', 'SalesAccount', or 'Deal'), targetable_id, creater_id."
      }
    },
    "required": [
      "PCID",
      "note"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_create\_sales\_activity

Create a sales activity

**Parameters:**

| Parameter        | Type   | Required | Default | Description                                                                                                                                                                                                                                                                                                                      |
| ---------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sales_activity` | object | Yes      | —       | Sales activity fields. Common keys: title (required), sales\_activity\_type\_id (required — from listSalesActivityTypes), targetable\_type ('Contact' \| 'SalesAccount' \| 'Deal'), targetable\_id, owner\_id, start\_date, end\_date, location, notes, latitude, longitude, outcome\_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_activity": {
        "type": "object",
        "description": "Sales activity fields. Common keys: title (required), sales_activity_type_id (required — from listSalesActivityTypes), targetable_type ('Contact' | 'SalesAccount' | 'Deal'), targetable_id, owner_id, start_date, end_date, location, notes, latitude, longitude, outcome_id, custom_field (object of cf_* keys)."
      }
    },
    "required": [
      "PCID",
      "sales_activity"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_create\_task

Create a task

**Parameters:**

| Parameter | Type   | Required | Default | Description                                                                                                                                                                                                                                                                                                                                                |
| --------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `task`    | object | Yes      | —       | Task fields. Common keys: title (required), description, due\_date (ISO-8601), owner\_id, status (0 = open, 1 = completed), targetable\_type (e.g., 'Contact', 'SalesAccount', 'Deal'), targetable\_id, task\_type\_id, outcome\_id, creater\_id, workflow\_id. Either targetable (with type + id) or top-level targetable\_type + targetable\_id is used. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "task": {
        "type": "object",
        "description": "Task fields. Common keys: title (required), description, due_date (ISO-8601), owner_id, status (0 = open, 1 = completed), targetable_type (e.g., 'Contact', 'SalesAccount', 'Deal'), targetable_id, task_type_id, outcome_id, creater_id, workflow_id. Either targetable (with type + id) or top-level targetable_type + targetable_id is used."
      }
    },
    "required": [
      "PCID",
      "task"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_delete\_appointment

Delete an appointment

**Parameters:**

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

<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 appointment."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_delete\_note

Delete a note

**Parameters:**

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

<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 note."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_delete\_sales\_activity

Delete a sales activity

**Parameters:**

| Parameter | Type    | Required | Default | Description                       |
| --------- | ------- | -------- | ------- | --------------------------------- |
| `id`      | integer | Yes      | —       | Numeric ID of the sales activity. |

<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 activity."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_delete\_task

Delete a task

**Parameters:**

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

<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 task."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_get\_appointment

Get an appointment by ID

**Parameters:**

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

<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 appointment."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_get\_sales\_activity

Get a sales activity by ID

**Parameters:**

| Parameter | Type    | Required | Default | Description                       |
| --------- | ------- | -------- | ------- | --------------------------------- |
| `id`      | integer | Yes      | —       | Numeric ID of the sales activity. |

<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 activity."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_get\_task

Get a task by ID

**Parameters:**

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

<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 task."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_list\_appointments

List appointments

**Parameters:**

| Parameter | Type    | Required | Default | Description                                                                                            |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------ |
| `filter`  | string  | No       | —       | Filter appointments by time range.                                                                     |
| `include` | string  | No       | —       | Comma-separated list of associations to side-load (e.g., "creater,targetable,appointment\_attendees"). |
| `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"
      },
      "filter": {
        "type": "string",
        "description": "Filter appointments by time range.",
        "enum": [
          "upcoming",
          "past",
          "all"
        ]
      },
      "include": {
        "type": "string",
        "description": "Comma-separated list of associations to side-load (e.g., \"creater,targetable,appointment_attendees\")."
      },
      "page": {
        "type": "integer",
        "description": "Page number for paginated results (default 1)."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_list\_contact\_document\_associations

List files and links for a contact

**Parameters:**

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

<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."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_list\_sales\_activities

List sales activities

**Parameters:**

| Parameter | Type    | Required | Default | Description                                                                                                                                                                                                                       |
| --------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page`    | integer | No       | —       | Page number for paginated results (default 1).                                                                                                                                                                                    |
| `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"
      },
      "page": {
        "type": "integer",
        "description": "Page number for paginated results (default 1)."
      },
      "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"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_list\_sales\_activity\_fields

List sales activity 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\_activities\_list\_tasks

List tasks

**Parameters:**

| Parameter | Type    | Required | Default | Description                                                                                         |
| --------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------- |
| `filter`  | string  | No       | —       | Filter tasks by status.                                                                             |
| `include` | string  | No       | —       | Comma-separated list of associations to side-load (e.g., "owner,targetable,users,creater,updater"). |
| `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"
      },
      "filter": {
        "type": "string",
        "description": "Filter tasks by status.",
        "enum": [
          "open",
          "due today",
          "due tomorrow",
          "overdue",
          "completed",
          "all"
        ]
      },
      "include": {
        "type": "string",
        "description": "Comma-separated list of associations to side-load (e.g., \"owner,targetable,users,creater,updater\")."
      },
      "page": {
        "type": "integer",
        "description": "Page number for paginated results (default 1)."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_log\_phone\_call

Log a phone call

**Parameters:**

| Parameter    | Type   | Required | Default | Description                                                                                                                                                                                                      |
| ------------ | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `phone_call` | object | Yes      | —       | Phone call log fields. Common keys: phone\_number, note, call\_direction ('incoming' or 'outgoing'), outcome\_id, targetable\_type, targetable\_id, from\_date, to\_date, duration, recording\_url, creater\_id. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "phone_call": {
        "type": "object",
        "description": "Phone call log fields. Common keys: phone_number, note, call_direction ('incoming' or 'outgoing'), outcome_id, targetable_type, targetable_id, from_date, to_date, duration, recording_url, creater_id."
      }
    },
    "required": [
      "PCID",
      "phone_call"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_update\_appointment

Update an appointment

**Parameters:**

| Parameter     | Type    | Required | Default | Description                           |
| ------------- | ------- | -------- | ------- | ------------------------------------- |
| `id`          | integer | Yes      | —       | Numeric ID of the appointment.        |
| `appointment` | object  | Yes      | —       | Partial appointment 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 appointment."
      },
      "appointment": {
        "type": "object",
        "description": "Partial appointment fields to update."
      }
    },
    "required": [
      "PCID",
      "id",
      "appointment"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_update\_note

Update a note

**Parameters:**

| Parameter | Type    | Required | Default | Description                                                        |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------ |
| `id`      | integer | Yes      | —       | Numeric ID of the note.                                            |
| `note`    | object  | Yes      | —       | Partial note fields to update. Typically used to edit description. |

<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 note."
      },
      "note": {
        "type": "object",
        "description": "Partial note fields to update. Typically used to edit description."
      }
    },
    "required": [
      "PCID",
      "id",
      "note"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_update\_sales\_activity

Update a sales activity

**Parameters:**

| Parameter        | Type    | Required | Default | Description                              |
| ---------------- | ------- | -------- | ------- | ---------------------------------------- |
| `id`             | integer | Yes      | —       | Numeric ID of the sales activity.        |
| `sales_activity` | object  | Yes      | —       | Partial sales-activity 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 activity."
      },
      "sales_activity": {
        "type": "object",
        "description": "Partial sales-activity fields to update."
      }
    },
    "required": [
      "PCID",
      "id",
      "sales_activity"
    ]
  }
  ```
</Expandable>

***

## freshsales\_activities\_update\_task

Update a task

**Parameters:**

| Parameter | Type    | Required | Default | Description                                                              |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------ |
| `id`      | integer | Yes      | —       | Numeric ID of the task.                                                  |
| `task`    | object  | Yes      | —       | Partial task fields to update. Set status: 1 to mark the task completed. |

<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 task."
      },
      "task": {
        "type": "object",
        "description": "Partial task fields to update. Set status: 1 to mark the task completed."
      }
    },
    "required": [
      "PCID",
      "id",
      "task"
    ]
  }
  ```
</Expandable>