ChatMo Open API

Ticket Comments

Endpoint

Ticket activity timeline — user comments with @-mentions and immutable changelog entries.

List ticket comments + changelog

GET

https://api.chatmo.io/v1/open-api

/tickets/{ticket_id}/comments

Paginated ticket_activities rows. Both COMMENT (user-written) and CHANGELOG (auto-generated audit) types live here — omit type to get both interleaved (newest first), or filter to one.

mentions is empty for CHANGELOG rows. metadata is {} for COMMENT and {field, old, new} for CHANGELOG.

List ticket comments + changelog › path Parameters

ticket_id

string · uuid · required

UUID of the ticket.

List ticket comments + changelog › query Parameters

type

string · enum

Enum values:

COMMENT

CHANGELOG

page

integer · min: 1 · max: 500

1-indexed page number. Capped at 500 to bound deep-scan cost.

Default: 1

limit

integer · min: 1 · max: 100

Default: 10

List ticket comments + changelog › Responses

Activities page.

success

boolean

object

GET/tickets/{ticket_id}/comments

curl --request GET \
  --url https://api.chatmo.io/v1/open-api/tickets/:ticket_id/comments

shell

Example Responses

{
  "success": true,
  "data": {
    "activities": [
      {
        "id": "act-1-12345678",
        "ticket_id": "tkt-1-12345678-1234-4abc-9def-0123456789ab",
        "user_id": "8c2f7b6e-4d9a-4b1f-9e3c-1a5d8b7a2c4e",
        "type": "CHANGELOG",
        "content": "Changed status from \"New Order\" to \"In Progress\"",
        "metadata": {
          "field": "status",
          "old": "New Order",
          "new": "In Progress"
        },
        "created_at": "2026-05-15T11:00:00.000Z",
        "updated_at": "2026-05-15T11:00:00.000Z",
        "user": {
          "id": "8c2f7b6e-4d9a-4b1f-9e3c-1a5d8b7a2c4e",
          "full_name": "Sarah Johnson",
          "avatar_url": null
        },
        "mentions": []
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 20,
      "total_items": 768,
      "total_pages": 39,
      "has_prev_page": false,
      "has_next_page": true
    }
  }
}

json

application/json

Create a comment

POST

https://api.chatmo.io/v1/open-api

/tickets/{ticket_id}/comments

Creates a user comment with optional @-mentions. The server does NOT re-parse content for mention tokens — the client is responsible for extracting the mention UUIDs from @[Name](uuid) and passing them explicitly in mentioned_user_ids[].

Create a comment › path Parameters

ticket_id

string · uuid · required

UUID of the ticket.

Create a comment › Request Body

content

string · minLength: 1 · maxLength: 5000 · required

mentioned_user_ids

string[] · maxItems: 50

Frontend-pre-parsed @[Name](uuid) tokens. Server does NOT re-parse content.

Create a comment › Responses

Comment created.

success

boolean

object

POST/tickets/{ticket_id}/comments

curl --request POST \
  --url https://api.chatmo.io/v1/open-api/tickets/:ticket_id/comments \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "content",
  "mentioned_user_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
'

shell

Example Request Body

{
  "content": "content",
  "mentioned_user_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

json

Example Responses

{
  "success": true,
  "data": {
    "activity": {
      "id": "act-1-12345678",
      "ticket_id": "tkt-1-12345678-1234-4abc-9def-0123456789ab",
      "user_id": "8c2f7b6e-4d9a-4b1f-9e3c-1a5d8b7a2c4e",
      "type": "CHANGELOG",
      "content": "Changed status from \"New Order\" to \"In Progress\"",
      "metadata": {
        "field": "status",
        "old": "New Order",
        "new": "In Progress"
      },
      "created_at": "2026-05-15T11:00:00.000Z",
      "updated_at": "2026-05-15T11:00:00.000Z",
      "user": {
        "id": "8c2f7b6e-4d9a-4b1f-9e3c-1a5d8b7a2c4e",
        "full_name": "Sarah Johnson",
        "avatar_url": null
      },
      "mentions": []
    }
  }
}

json

application/json

Edit a comment

PATCH

https://api.chatmo.io/v1/open-api

/tickets/{ticket_id}/comments/{comment_id}

Edit comment content and optionally replace mentions. The caller must be the original author — otherwise 403 only the comment author can edit this comment.

CHANGELOG rows are immutable audit artifacts — targeting one returns 404 (same shape as not-found so the caller cannot probe).

Mention replacement semantics: omit mentioned_user_ids to leave existing mentions untouched; pass [] to clear all; pass [a,b] to replace with [a,b].

Edit a comment › path Parameters

ticket_id

string · uuid · required

UUID of the ticket.

comment_id

string · uuid · required

UUID of the comment (ticket_activities row of type=COMMENT).

Edit a comment › Request Body

content

string · minLength: 1 · maxLength: 5000 · required

mentioned_user_ids

string[]

Replacement semantics — omit to leave existing mentions untouched; [] to clear; [a,b] to replace.

Edit a comment › Responses

Updated.

success

boolean

object

PATCH/tickets/{ticket_id}/comments/{comment_id}

curl --request PATCH \
  --url https://api.chatmo.io/v1/open-api/tickets/:ticket_id/comments/:comment_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "content",
  "mentioned_user_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
'

shell

Example Request Body

{
  "content": "content",
  "mentioned_user_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

json

Example Responses

{
  "success": true,
  "data": {
    "activity": {
      "id": "act-1-12345678",
      "ticket_id": "tkt-1-12345678-1234-4abc-9def-0123456789ab",
      "user_id": "8c2f7b6e-4d9a-4b1f-9e3c-1a5d8b7a2c4e",
      "type": "CHANGELOG",
      "content": "Changed status from \"New Order\" to \"In Progress\"",
      "metadata": {
        "field": "status",
        "old": "New Order",
        "new": "In Progress"
      },
      "created_at": "2026-05-15T11:00:00.000Z",
      "updated_at": "2026-05-15T11:00:00.000Z",
      "user": {
        "id": "8c2f7b6e-4d9a-4b1f-9e3c-1a5d8b7a2c4e",
        "full_name": "Sarah Johnson",
        "avatar_url": null
      },
      "mentions": []
    }
  }
}

json

application/json

Tickets Ticket Attachments

ChatMo Open API

Ticket Comments

Endpoint

Ticket activity timeline — user comments with @-mentions and immutable changelog entries.

List ticket comments + changelog

GET

https://api.chatmo.io/v1/open-api

/tickets/{ticket_id}/comments

Paginated ticket_activities rows. Both COMMENT (user-written) and CHANGELOG (auto-generated audit) types live here — omit type to get both interleaved (newest first), or filter to one.

mentions is empty for CHANGELOG rows. metadata is {} for COMMENT and {field, old, new} for CHANGELOG.

List ticket comments + changelog › path Parameters

ticket_id

string · uuid · required

UUID of the ticket.

List ticket comments + changelog › query Parameters

type

string · enum

Enum values:

COMMENT

CHANGELOG

page

integer · min: 1 · max: 500

1-indexed page number. Capped at 500 to bound deep-scan cost.

Default: 1

limit

integer · min: 1 · max: 100

Default: 10

List ticket comments + changelog › Responses

Activities page.

success

boolean

object

GET/tickets/{ticket_id}/comments

curl --request GET \
  --url https://api.chatmo.io/v1/open-api/tickets/:ticket_id/comments

shell

Example Responses

{
  "success": true,
  "data": {
    "activities": [
      {
        "id": "act-1-12345678",
        "ticket_id": "tkt-1-12345678-1234-4abc-9def-0123456789ab",
        "user_id": "8c2f7b6e-4d9a-4b1f-9e3c-1a5d8b7a2c4e",
        "type": "CHANGELOG",
        "content": "Changed status from \"New Order\" to \"In Progress\"",
        "metadata": {
          "field": "status",
          "old": "New Order",
          "new": "In Progress"
        },
        "created_at": "2026-05-15T11:00:00.000Z",
        "updated_at": "2026-05-15T11:00:00.000Z",
        "user": {
          "id": "8c2f7b6e-4d9a-4b1f-9e3c-1a5d8b7a2c4e",
          "full_name": "Sarah Johnson",
          "avatar_url": null
        },
        "mentions": []
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 20,
      "total_items": 768,
      "total_pages": 39,
      "has_prev_page": false,
      "has_next_page": true
    }
  }
}

json

application/json

Create a comment

POST

https://api.chatmo.io/v1/open-api

/tickets/{ticket_id}/comments

Create a comment › path Parameters

ticket_id

string · uuid · required

UUID of the ticket.

Create a comment › Request Body

content

string · minLength: 1 · maxLength: 5000 · required

mentioned_user_ids

string[] · maxItems: 50

Frontend-pre-parsed @[Name](uuid) tokens. Server does NOT re-parse content.

Create a comment › Responses

Comment created.

success

boolean

object

POST/tickets/{ticket_id}/comments

curl --request POST \
  --url https://api.chatmo.io/v1/open-api/tickets/:ticket_id/comments \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "content",
  "mentioned_user_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
'

shell

Example Request Body

{
  "content": "content",
  "mentioned_user_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

json

Example Responses

{
  "success": true,
  "data": {
    "activity": {
      "id": "act-1-12345678",
      "ticket_id": "tkt-1-12345678-1234-4abc-9def-0123456789ab",
      "user_id": "8c2f7b6e-4d9a-4b1f-9e3c-1a5d8b7a2c4e",
      "type": "CHANGELOG",
      "content": "Changed status from \"New Order\" to \"In Progress\"",
      "metadata": {
        "field": "status",
        "old": "New Order",
        "new": "In Progress"
      },
      "created_at": "2026-05-15T11:00:00.000Z",
      "updated_at": "2026-05-15T11:00:00.000Z",
      "user": {
        "id": "8c2f7b6e-4d9a-4b1f-9e3c-1a5d8b7a2c4e",
        "full_name": "Sarah Johnson",
        "avatar_url": null
      },
      "mentions": []
    }
  }
}

json

application/json

Edit a comment

PATCH

https://api.chatmo.io/v1/open-api

/tickets/{ticket_id}/comments/{comment_id}

Edit comment content and optionally replace mentions. The caller must be the original author — otherwise 403 only the comment author can edit this comment.

CHANGELOG rows are immutable audit artifacts — targeting one returns 404 (same shape as not-found so the caller cannot probe).

Mention replacement semantics: omit mentioned_user_ids to leave existing mentions untouched; pass [] to clear all; pass [a,b] to replace with [a,b].

Edit a comment › path Parameters

ticket_id

string · uuid · required

UUID of the ticket.

comment_id

string · uuid · required

UUID of the comment (ticket_activities row of type=COMMENT).

Edit a comment › Request Body

content

string · minLength: 1 · maxLength: 5000 · required

mentioned_user_ids

string[]

Replacement semantics — omit to leave existing mentions untouched; [] to clear; [a,b] to replace.

Edit a comment › Responses

Updated.

success

boolean

object

PATCH/tickets/{ticket_id}/comments/{comment_id}

curl --request PATCH \
  --url https://api.chatmo.io/v1/open-api/tickets/:ticket_id/comments/:comment_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "content",
  "mentioned_user_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
'

shell

Example Request Body

{
  "content": "content",
  "mentioned_user_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

json

Example Responses

{
  "success": true,
  "data": {
    "activity": {
      "id": "act-1-12345678",
      "ticket_id": "tkt-1-12345678-1234-4abc-9def-0123456789ab",
      "user_id": "8c2f7b6e-4d9a-4b1f-9e3c-1a5d8b7a2c4e",
      "type": "CHANGELOG",
      "content": "Changed status from \"New Order\" to \"In Progress\"",
      "metadata": {
        "field": "status",
        "old": "New Order",
        "new": "In Progress"
      },
      "created_at": "2026-05-15T11:00:00.000Z",
      "updated_at": "2026-05-15T11:00:00.000Z",
      "user": {
        "id": "8c2f7b6e-4d9a-4b1f-9e3c-1a5d8b7a2c4e",
        "full_name": "Sarah Johnson",
        "avatar_url": null
      },
      "mentions": []
    }
  }
}

json

application/json

Tickets Ticket Attachments