GuidesAPI DocsChangelogMy AppsSeismic Exchange
API Docs

Update the content or metadata of an existing comment

put
https://api.seismic.com/programs/v2/spaces//nodes//comments/

Updates an existing comment's content or metadata while preserving its relationships and discussion context.
Only the comment author or users with appropriate management permissions can update comments. The update
operation records activity events for tracking and maintains updated timestamps on the comment.

Key Features:

  • Updates comment content while preserving relationships and metadata
  • Validates user permissions and ownership before allowing modifications
  • Maintains activity tracking and updated timestamps for modified comments
  • Returns updated comment object with new timestamps and content
  • Preserves comment threading and parent-child relationships

Authorization Logic:

  1. User must have a valid JWT token with program management scopes
  2. Token is valid for this operation
  3. User must be the comment author or have management permissions for the entity
  4. User must have access to the comment and its parent entity

Usage Example:

Correct typos or update comment content to reflect new information while maintaining discussion context.

Path Params
string
required
length between 7 and 22

The unique identifier of the space containing the target entity. This determines the scope of entity queries and ensures proper access control. The space must be accessible to the authenticated user with appropriate permissions. It can be the unique identifier (GUID) of the space or the word "default" to indicate the default programs space. Common values include "default" and "rkr83lapKkyCJuLLWqLqzB".

string
required

The unique identifier of the entity (program, task, or request) containing the comment. This entity must exist
within the specified space and be accessible to the authenticated user.

string
required

The unique identifier of the comment to update. The comment must exist on the specified entity and the user
must have appropriate permissions to modify it.

Body Params
string | null

JSON-encoded annotation payload containing visual markup metadata such as coordinates, dimensions, color, shape type, and positioning information for rendering annotations on content. Required when annotationType is specified to display visual highlights, drawings, or markers. Set to null for plain text comments without visual annotations. Use to preserve annotation data when updating comments that include visual markup.

string | null

Classification of the annotation type indicating the visual markup style associated with this comment. Common values include 'highlight' for text highlighting, 'text' for text boxes, 'drawing' for freeform shapes, or 'marker' for point annotations. Required when annotationPayload is provided. Set to null for standard text-only comments without visual elements. Use to determine how to render the annotation UI and interpret the payload structure.

string

Updated textual content of the comment containing the user's message, feedback, or annotation note. Supports plain text format and can include questions, suggestions, or responses. Required field that replaces the existing comment content. Use when modifying the comment's text while preserving other metadata like timestamps and author information.

boolean | null

Boolean flag indicating whether the comment thread has been marked as resolved or completed. Set to true when the issue or question raised in the comment has been addressed. Set to false to reopen previously resolved comments. Use to track comment resolution status, filter active versus resolved comments, and manage workflow completion states.

Responses

Updated about 23 hours ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 23 hours ago