Release comments overview

Release comments are the discussion thread on a release.

The release comment object

Attributes

• comment_html string

  The comment html.

• comment_id string (uuid)

  The related comment.

• created_at string (date-time)

  When the release comment was created.

• updated_at string (date-time)

  When the release comment was last updated.

• created_by_id string (uuid)

  The user who created the release comment.

• updated_by_id string (uuid) or null

  The user who last updated the release comment. null until someone updates it.

• edited_at string (date-time)

  The edited at.

• id string (uuid)

  Unique identifier.

• is_hidden boolean

  Whether the comment is hidden.

• is_resolved boolean

  Whether the comment is resolved.

• parent_id string (uuid)

  The related parent.

• release_id string (uuid)

  The related release.

Response200

{
  "comment_html": "example",
  "comment_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "edited_at": "2026-01-14T09:22:41.478363Z",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_hidden": false,
  "is_resolved": false,
  "parent_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "release_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f"
}

Endpoints

Method	Path	Description
GET	/api/v2/workspaces/{slug}/releases/{release_id}/comments/	List release comments
GET	/api/v2/workspaces/{slug}/releases/{release_id}/comments/{pk}/	Get a release comment
POST	/api/v2/workspaces/{slug}/releases/{release_id}/comments/	Create a release comment
PATCH	/api/v2/workspaces/{slug}/releases/{release_id}/comments/{pk}/	Update a release comment
DELETE	/api/v2/workspaces/{slug}/releases/{release_id}/comments/{pk}/	Delete a release comment

Response shaping

Every release comment read accepts ?fields= for sparse responses. See Sparse fields. Errors follow the shared problem+json contract.