{
  "opencollection": "1.0.0",
  "info": {
    "name": "Freshworks Freshcaller Accounts Conversations API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Api-Auth",
      "value": "{{X-Api-Auth}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Conversations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all conversations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshcaller.com/api/v1/conversations",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number for pagination."
              },
              {
                "name": "items_per_page",
                "value": "",
                "type": "query",
                "description": "Number of items per page."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter conversations by status (new, assigned, resolved, reopened)."
              },
              {
                "name": "assigned_agent_id",
                "value": "",
                "type": "query",
                "description": "Filter by assigned agent ID."
              },
              {
                "name": "assigned_group_id",
                "value": "",
                "type": "query",
                "description": "Filter by assigned group ID."
              }
            ]
          },
          "docs": "Retrieves a paginated list of all conversations. The response does not include messages or user details by default."
        },
        {
          "info": {
            "name": "Create a conversation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{domain}.freshcaller.com/api/v1/conversations",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new conversation with an initial message. Requires a user ID or user details and the message content."
        },
        {
          "info": {
            "name": "View a conversation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshcaller.com/api/v1/conversations/:conversation_id",
            "params": [
              {
                "name": "conversation_id",
                "value": "",
                "type": "path",
                "description": "The ID of the conversation."
              }
            ]
          },
          "docs": "Retrieves the details of a specific conversation by its ID. Messages and user attributes are not included by default."
        },
        {
          "info": {
            "name": "Update a conversation",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{domain}.freshcaller.com/api/v1/conversations/:conversation_id",
            "params": [
              {
                "name": "conversation_id",
                "value": "",
                "type": "path",
                "description": "The ID of the conversation."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the properties of an existing conversation such as status and assignment."
        },
        {
          "info": {
            "name": "List all conversations of a ticket",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{domain}.freshcaller.com/api/v1/tickets/:ticket_id/conversations",
            "params": [
              {
                "name": "ticket_id",
                "value": "",
                "type": "path",
                "description": "The ID of the ticket."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number for pagination."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results per page (max 100)."
              }
            ]
          },
          "docs": "Retrieves all conversations (replies and notes) associated with a specific ticket."
        },
        {
          "info": {
            "name": "Reply to a ticket",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{domain}.freshcaller.com/api/v1/tickets/:ticket_id/reply",
            "params": [
              {
                "name": "ticket_id",
                "value": "",
                "type": "path",
                "description": "The ID of the ticket."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds a public reply to a ticket. The reply is sent to all recipients associated with the ticket."
        },
        {
          "info": {
            "name": "Create a note on a ticket",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{domain}.freshcaller.com/api/v1/tickets/:ticket_id/notes",
            "params": [
              {
                "name": "ticket_id",
                "value": "",
                "type": "path",
                "description": "The ID of the ticket."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds a private or public note to a ticket. Notes are used for internal communication or additional context."
        }
      ]
    }
  ],
  "bundled": true
}