integrations

Edit a comment (legacy)

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://docs.usehearsay.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "integrations MCP server": {
    "url": "https://docs.usehearsay.com/mcp"
  }
}
Close
PATCH /comments/case/{caseId}/message/{messageId}/{commentId}
Access token

Edits the caller's own comment on a message. Prefer PATCH /comments/case/:caseId/:commentId.

Headers

  • organization string Required

    id of the selected (active) organization

Path parameters

  • messageId string Required

    Id of the message

  • commentId string Required

    Id of the comment to update

  • caseId string Required

    Id of the case

application/json

Body Required

Updated comment

  • text string Required

Responses

  • 201 application/json
    Hide response attributes Show response attributes object
    • data object Required
      Hide data attributes Show data attributes object
      • createdAt string(date-time) Required
      • updatedAt string(date-time) Required
      • id string Required
      • text string Required
      • source string | null Required

        Id of the commented item (its kind is sourceType)

      • sourceType string Required

        Values are DeviceMessage, DeviceConversation, UserEmailData, FinancialAccount, CaseFile, UserEmailDataThread, LinkedInConversation, LinkedInJobApplication, or AiChatConversation.

      • deviceMessage string | null Required

        Id of the commented message, for message comments

      • user object Required

        The full record on routes that load it; null (or an empty list) on routes that do not.

        Hide user attributes Show user attributes object
        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • name string Required
        • email string Required
        • phone array[string] Required
        • isActive boolean Required
        • isEmailVerified boolean Required
        • lastActive string(date-time) Required
        • roles array[string] Required
        • avatar object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide avatar attributes Show avatar attributes object
          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • providerId string Required
          • convertedName string | null Required
          • convertedProviderId string Required
          • provider string Required
          • size number Required

            Size in bytes

          • transferState number | null Required
        • onboardingStatus string | null Required
        • userType string | null Required
        • firstName string Required
        • lastName string Required
        • initials string Required
        • userOrganizations array[object]

          Only filled on the signed-in user's own profile; absent or empty on a user nested in another record.

      • parent string | null Required

        Id of the comment this one replies to

      • replyCount number Required
    • statusCode number Required
    • timestamp string(date-time) Required
PATCH /comments/case/{caseId}/message/{messageId}/{commentId} 
curl \
 --request PATCH 'http://api.example.com/comments/case/{caseId}/message/{messageId}/{commentId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "organization: string" \
 --data '{
  "text": "string"
}'
Request examples 
# Headers
organization: string

# Payload
{
  "text": "string"
}
Response examples (201) 
{
  "data": {
    "createdAt": "2026-01-15T14:30:00.000Z",
    "updatedAt": "2026-01-15T14:30:00.000Z",
    "id": "507f1f77bcf86cd799439011",
    "text": "Relevant to the timeline",
    "source": "507f1f77bcf86cd799439011",
    "sourceType": "DeviceMessage",
    "deviceMessage": "507f1f77bcf86cd799439011",
    "user": {
      "createdAt": "2026-01-15T14:30:00.000Z",
      "updatedAt": "2026-01-15T14:30:00.000Z",
      "id": "507f1f77bcf86cd799439011",
      "name": "Jane Doe",
      "email": "jane.doe@example.com",
      "phone": [
        "+15555550100"
      ],
      "isActive": true,
      "isEmailVerified": true,
      "lastActive": "2026-01-15T14:30:00.000Z",
      "roles": [
        "user"
      ],
      "avatar": {
        "createdAt": "2026-01-15T14:30:00.000Z",
        "updatedAt": "2026-01-15T14:30:00.000Z",
        "id": "507f1f77bcf86cd799439011",
        "name": "photo.heic",
        "providerId": "uploads/507f1f77bcf86cd799439011/photo.heic",
        "convertedName": "photo.jpg",
        "convertedProviderId": "uploads/507f1f77bcf86cd799439011/photo.jpg",
        "provider": "s3",
        "size": 204800,
        "transferState": 42.0
      },
      "onboardingStatus": "completed",
      "userType": "attorney",
      "firstName": "Jane",
      "lastName": "Doe",
      "initials": "JD",
      "userOrganizations": [
        {}
      ]
    },
    "parent": "507f1f77bcf86cd799439011",
    "replyCount": 0
  },
  "statusCode": 201,
  "timestamp": "2026-01-15T10:15:00.000Z"
}