Create engagement transcript comment

View as Markdown
Creates a transcript comment on a workspace engagement's transcript timeline. When `transcript_timeline_id` is omitted, the server resolves to the engagement's primary transcript timeline. Requires both `engagements:read` and `transcript_comments:write` scopes. Creating 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

engagement_idstringRequired

Request

This endpoint expects an object.
bodystringRequired1-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.

transcript_timeline_idstringOptionalformat: "^tt_[A-Za-z0-9]+$"
Transcript timeline identifier. When omitted, the server resolves to the engagement's primary transcript timeline.
anchorobjectOptional

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

Created transcript comment response.
objectenum
Allowed values:
idstringformat: "^tano_[A-Za-z0-9]+$"
engagement_idstringformat: "^ngmt_[A-Za-z0-9]+$"
transcript_timeline_idstringformat: "^tt_[A-Za-z0-9]+$"
bodystring
statusenum
Allowed values:
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