Explore documentation
  1. Welcome to Telemetry 👋
  2. Quick start guide
  3. Wide events vs. metrics
  4. Ingesting data
    1. Better Stack collector
    2. OpenTelemetry
    3. Vector
    4. Ingesting via HTTP API
    5. Ingesting metrics
    6. Ingesting logs
    7. Migrating to Better Stack
  5. Using the product
    1. AI SRE ↗
    2. MCP server ↗
    3. Transforming ingested data
    4. Querying data
    5. Tracing
    6. Grafana
    7. Alerts
  6. Telemetry API
    1. Getting an API token
    2. Sources & collectors
    3. Dashboards
      1. Dashboards API
      2. Charts API
      3. Chart comments API
        1. List all comments GET
        2. Get a single comment GET
        3. Create a comment POST
        4. Update a comment PATCH
        5. Remove a comment DELETE
      4. Dashboard sections API
      5. Dashboard alerts API
      6. Dashboard groups API
    4. Explorations
    5. Alerts API
    6. Connections API
    7. Query API ↗
    8. Usage API ↗
  7. Alternative to
    1. Lightstep

Update a chart comment

Updates the content of a chart comment, or moves it to a different point in time. You only need to provide the fields you want to change.

PATCH https://telemetry.betterstack.com/api/v2/dashboards/{dashboard_id}/charts/{chart_id}/comments/{id}

URL parameters

dashboard_id
required integer

The unique identifier of the dashboard.

chart_id
required integer

The unique identifier of the chart.

id
required integer

The unique identifier of the comment to update.

Headers

Authorization
required string

Bearer $TOKEN

Content-Type
required string

application/json

Body parameters

content
string

The new content of the comment. Markdown is supported for formatting.

dt
string

The new point on the chart's time axis to pin the comment to, as a datetime such as 2026-08-17T13:00:00Z.

200

The comment was updated successfully.

Response body

{
  "data": {
    "id": "1441",
    "type": "chart_comment",
    "attributes": {
      "chart_id": 18718,
      "content": "Deployed v2.1.1",
      "created_at": "2026-08-17T12:52:21.837Z",
      "updated_at": "2026-08-17T12:56:29.769Z",
      "dt": "2026-08-17T13:00:00.000Z",
      "plaintext_content": "Deployed v2.1.1",
      "api_authored": true
    }
  }
}
403

The comment was not created through this API and can only be changed by whoever wrote it.

422

dt is not a datetime, content is blank, or an attribute that cannot be updated was sent.

404

A comment with the specified ID was not found on this chart.

Example request

cURL
curl --request PATCH \
  --url https://telemetry.betterstack.com/api/v2/dashboards/1234/charts/18718/comments/1441 \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "content": "Deployed v2.1.1",
    "dt": "2026-08-17T13:00:00Z"
  }'


What you can update

You can update a comment created through this API, meaning one whose api_authored attribute is true. With an OAuth token you can also update that team member's own comments. Everything else returns 403, including comments written by other team members and the incident comments synced onto the chart from Uptime.

user_email is not accepted here. A mention is part of the comment content, so to change one, send the whole content you want.

Previous article

Create a chart comment

Next article

Remove a chart comment