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

# freshchat

> Freshchat Messaging

**Server path:** `/freshchat` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                            | Description                      |
| ------------------------------------------------------------------------------- | -------------------------------- |
| [`freshchat_create_conversation`](#freshchat_create_conversation)               | Create a conversation            |
| [`freshchat_create_user`](#freshchat_create_user)                               | Create a user                    |
| [`freshchat_get_agent`](#freshchat_get_agent)                                   | View an agent                    |
| [`freshchat_get_channel`](#freshchat_get_channel)                               | View a channel                   |
| [`freshchat_get_conversation`](#freshchat_get_conversation)                     | View a conversation              |
| [`freshchat_get_group`](#freshchat_get_group)                                   | View a group                     |
| [`freshchat_get_user`](#freshchat_get_user)                                     | View a user                      |
| [`freshchat_list_agents`](#freshchat_list_agents)                               | List all agents                  |
| [`freshchat_list_channels`](#freshchat_list_channels)                           | List all channels                |
| [`freshchat_list_conversation_messages`](#freshchat_list_conversation_messages) | List messages in a conversation  |
| [`freshchat_list_conversations`](#freshchat_list_conversations)                 | List all conversations           |
| [`freshchat_list_groups`](#freshchat_list_groups)                               | List all groups                  |
| [`freshchat_list_users`](#freshchat_list_users)                                 | List all users                   |
| [`freshchat_send_message`](#freshchat_send_message)                             | Send a message in a conversation |
| [`freshchat_update_conversation`](#freshchat_update_conversation)               | Update a conversation            |
| [`freshchat_update_user`](#freshchat_update_user)                               | Update a user                    |

***

## freshchat\_create\_conversation

Create a conversation

**Parameters:**

| Parameter    | Type      | Required | Default | Description                            |
| ------------ | --------- | -------- | ------- | -------------------------------------- |
| `app_id`     | string    | Yes      | —       | ID of the Freshchat application.       |
| `channel_id` | string    | Yes      | —       | ID of the channel.                     |
| `messages`   | object\[] | Yes      | —       | Initial messages for the conversation. |
| `users`      | object\[] | No       | —       | Users to involve in the conversation.  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "app_id": {
        "type": "string",
        "description": "ID of the Freshchat application."
      },
      "channel_id": {
        "type": "string",
        "description": "ID of the channel."
      },
      "messages": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "message_type": {
              "type": "string",
              "enum": [
                "normal",
                "private"
              ],
              "description": "Type of message."
            },
            "actor_type": {
              "type": "string",
              "enum": [
                "user",
                "agent"
              ],
              "description": "Type of actor sending the message."
            },
            "actor_id": {
              "type": "string",
              "description": "ID of the actor sending the message."
            },
            "message_parts": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "text": {
                    "type": "object"
                  }
                }
              },
              "description": "Parts composing the message content."
            }
          },
          "required": [
            "message_parts",
            "actor_type",
            "actor_id"
          ]
        },
        "description": "Initial messages for the conversation."
      },
      "users": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "User ID."
            }
          }
        },
        "description": "Users to involve in the conversation."
      }
    },
    "required": [
      "PCID",
      "app_id",
      "channel_id",
      "messages"
    ]
  }
  ```
</Expandable>

***

## freshchat\_create\_user

Create a user

**Parameters:**

| Parameter    | Type      | Required | Default | Description             |
| ------------ | --------- | -------- | ------- | ----------------------- |
| `email`      | string    | No       | —       | Email address.          |
| `first_name` | string    | No       | —       | First name.             |
| `last_name`  | string    | No       | —       | Last name.              |
| `phone`      | string    | No       | —       | Phone number.           |
| `properties` | object\[] | No       | —       | Custom user properties. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "email": {
        "type": "string",
        "description": "Email address."
      },
      "first_name": {
        "type": "string",
        "description": "First name."
      },
      "last_name": {
        "type": "string",
        "description": "Last name."
      },
      "phone": {
        "type": "string",
        "description": "Phone number."
      },
      "properties": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "Property name."
            },
            "value": {
              "type": "string",
              "description": "Property value."
            }
          }
        },
        "description": "Custom user properties."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## freshchat\_get\_agent

View an agent

**Parameters:**

| Parameter  | Type   | Required | Default | Description          |
| ---------- | ------ | -------- | ------- | -------------------- |
| `agent_id` | string | Yes      | —       | The ID of the agent. |

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

***

## freshchat\_get\_channel

View a channel

**Parameters:**

| Parameter    | Type   | Required | Default | Description            |
| ------------ | ------ | -------- | ------- | ---------------------- |
| `channel_id` | string | Yes      | —       | The ID of the channel. |

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

***

## freshchat\_get\_conversation

View a conversation

**Parameters:**

| Parameter         | Type   | Required | Default | Description                 |
| ----------------- | ------ | -------- | ------- | --------------------------- |
| `conversation_id` | string | Yes      | —       | The ID of the conversation. |

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

***

## freshchat\_get\_group

View a group

**Parameters:**

| Parameter  | Type   | Required | Default | Description          |
| ---------- | ------ | -------- | ------- | -------------------- |
| `group_id` | string | Yes      | —       | The ID of the group. |

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

***

## freshchat\_get\_user

View a user

**Parameters:**

| Parameter | Type   | Required | Default | Description         |
| --------- | ------ | -------- | ------- | ------------------- |
| `user_id` | string | Yes      | —       | The ID of the user. |

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

***

## freshchat\_list\_agents

List all agents

**Parameters:**

| Parameter        | Type    | Required | Default | Description                 |
| ---------------- | ------- | -------- | ------- | --------------------------- |
| `page`           | integer | No       | —       | Page number for pagination. |
| `items_per_page` | integer | No       | —       | Number of items per page.   |

<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 pagination."
      },
      "items_per_page": {
        "type": "integer",
        "description": "Number of items per page."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## freshchat\_list\_channels

List all channels

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

***

## freshchat\_list\_conversation\_messages

List messages in a conversation

**Parameters:**

| Parameter         | Type    | Required | Default | Description                 |
| ----------------- | ------- | -------- | ------- | --------------------------- |
| `conversation_id` | string  | Yes      | —       | The ID of the conversation. |
| `page`            | integer | No       | —       | Page number for pagination. |
| `items_per_page`  | integer | No       | —       | Number of items per page.   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "conversation_id": {
        "type": "string",
        "description": "The ID of the conversation."
      },
      "page": {
        "type": "integer",
        "description": "Page number for pagination."
      },
      "items_per_page": {
        "type": "integer",
        "description": "Number of items per page."
      }
    },
    "required": [
      "PCID",
      "conversation_id"
    ]
  }
  ```
</Expandable>

***

## freshchat\_list\_conversations

List all conversations

**Parameters:**

| Parameter           | Type    | Required | Default | Description                                                         |
| ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------- |
| `page`              | integer | No       | —       | Page number for pagination.                                         |
| `items_per_page`    | integer | No       | —       | Number of items per page.                                           |
| `status`            | string  | No       | —       | Filter conversations by status (new, assigned, resolved, reopened). |
| `assigned_agent_id` | string  | No       | —       | Filter by assigned agent ID.                                        |
| `assigned_group_id` | string  | No       | —       | Filter by assigned group ID.                                        |

<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 pagination."
      },
      "items_per_page": {
        "type": "integer",
        "description": "Number of items per page."
      },
      "status": {
        "type": "string",
        "description": "Filter conversations by status (new, assigned, resolved, reopened)."
      },
      "assigned_agent_id": {
        "type": "string",
        "description": "Filter by assigned agent ID."
      },
      "assigned_group_id": {
        "type": "string",
        "description": "Filter by assigned group ID."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## freshchat\_list\_groups

List all groups

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

***

## freshchat\_list\_users

List all users

**Parameters:**

| Parameter        | Type    | Required | Default | Description                 |
| ---------------- | ------- | -------- | ------- | --------------------------- |
| `page`           | integer | No       | —       | Page number for pagination. |
| `items_per_page` | integer | No       | —       | Number of items per page.   |

<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 pagination."
      },
      "items_per_page": {
        "type": "integer",
        "description": "Number of items per page."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## freshchat\_send\_message

Send a message in a conversation

**Parameters:**

| Parameter         | Type      | Required | Default | Description                          |
| ----------------- | --------- | -------- | ------- | ------------------------------------ |
| `conversation_id` | string    | Yes      | —       | The ID of the conversation.          |
| `actor_id`        | string    | Yes      | —       | ID of the actor sending the message. |
| `actor_type`      | string    | Yes      | —       | Type of actor sending the message.   |
| `message_parts`   | object\[] | Yes      | —       | Parts composing the message content. |
| `message_type`    | string    | No       | —       | Type of message.                     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "conversation_id": {
        "type": "string",
        "description": "The ID of the conversation."
      },
      "actor_id": {
        "type": "string",
        "description": "ID of the actor sending the message."
      },
      "actor_type": {
        "type": "string",
        "description": "Type of actor sending the message.",
        "enum": [
          "user",
          "agent"
        ]
      },
      "message_parts": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "text": {
              "type": "object",
              "description": "The text value"
            }
          }
        },
        "description": "Parts composing the message content."
      },
      "message_type": {
        "type": "string",
        "description": "Type of message.",
        "enum": [
          "normal",
          "private"
        ]
      }
    },
    "required": [
      "PCID",
      "conversation_id",
      "actor_id",
      "actor_type",
      "message_parts"
    ]
  }
  ```
</Expandable>

***

## freshchat\_update\_conversation

Update a conversation

**Parameters:**

| Parameter           | Type   | Required | Default | Description                      |
| ------------------- | ------ | -------- | ------- | -------------------------------- |
| `conversation_id`   | string | Yes      | —       | The ID of the conversation.      |
| `assigned_agent_id` | string | No       | —       | ID of the agent to assign.       |
| `assigned_group_id` | string | No       | —       | ID of the group to assign.       |
| `status`            | string | No       | —       | New status for the conversation. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "conversation_id": {
        "type": "string",
        "description": "The ID of the conversation."
      },
      "assigned_agent_id": {
        "type": "string",
        "description": "ID of the agent to assign."
      },
      "assigned_group_id": {
        "type": "string",
        "description": "ID of the group to assign."
      },
      "status": {
        "type": "string",
        "description": "New status for the conversation.",
        "enum": [
          "new",
          "assigned",
          "resolved",
          "reopened"
        ]
      }
    },
    "required": [
      "PCID",
      "conversation_id"
    ]
  }
  ```
</Expandable>

***

## freshchat\_update\_user

Update a user

**Parameters:**

| Parameter    | Type      | Required | Default | Description             |
| ------------ | --------- | -------- | ------- | ----------------------- |
| `user_id`    | string    | Yes      | —       | The ID of the user.     |
| `email`      | string    | No       | —       | Email address.          |
| `first_name` | string    | No       | —       | First name.             |
| `last_name`  | string    | No       | —       | Last name.              |
| `phone`      | string    | No       | —       | Phone number.           |
| `properties` | object\[] | No       | —       | Custom user properties. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "user_id": {
        "type": "string",
        "description": "The ID of the user."
      },
      "email": {
        "type": "string",
        "description": "Email address."
      },
      "first_name": {
        "type": "string",
        "description": "First name."
      },
      "last_name": {
        "type": "string",
        "description": "Last name."
      },
      "phone": {
        "type": "string",
        "description": "Phone number."
      },
      "properties": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "Property name."
            },
            "value": {
              "type": "string",
              "description": "Property value."
            }
          }
        },
        "description": "Custom user properties."
      }
    },
    "required": [
      "PCID",
      "user_id"
    ]
  }
  ```
</Expandable>