API ReferenceTranscript Comments

Update transcript comment

View as Markdown

Updates a single workspace transcript comment’s body and/or status. Requires both engagements:read and transcript_comments:write scopes. Updating a transcript comment for a private engagement also requires engagements:private:read.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

transcript_comment_idstringRequired

Request

This endpoint expects an object.
bodystringOptional1-50000 characters

Transcript comment body text. Leading and trailing whitespace is trimmed server-side; the trimmed value must be at least 1 character. Whitespace-only strings are rejected with 422.

statusenumOptional

Response headers

X-RateLimit-Limitinteger

Maximum number of authenticated requests allowed for the workspace in the current 60-second window. The limit is 1000 and applies to all /api/v2 resource routes (GET, POST, PATCH, and DELETE), shared across every credential for the workspace.

X-RateLimit-Remaininginteger
Number of requests remaining in the current window before the limit is exceeded.
X-RateLimit-Resetinteger

Unix epoch seconds when the current rate-limit window resets.

X-Api-VersionstringOptional

Response

Updated transcript comment response.
objectenum
idstringformat: "^tano_[A-Za-z0-9]+$"
engagement_idstringformat: "^ngmt_[A-Za-z0-9]+$"
transcript_timeline_idstringformat: "^tt_[A-Za-z0-9]+$"
bodystring
statusenum
anchorobject
created_bystringformat: "^usr_[A-Za-z0-9]+$"
resolved_bystring or nullformat: "^usr_[A-Za-z0-9]+$"
resolved_atdatetime or null
created_atdatetime
updated_atdatetime

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error