Shared Links

Edit a comment through a share link

Edit the text of your own comment through a dashboard share link. Allowed while comments are on with comments.mode set to reply. Resolving threads stays in the app. No API key or access token: the share link token is the only credential. The media must be in one of the dashboard's folders. Every refusal returns the same 404 {"message": "Not found."}, so a link holder cannot tell which check failed. The entry is recorded under reviewerName via this dashboard. The name is chosen by the link holder and not authenticated, the same as feedback; only a name the dashboard allows is accepted. A name can change or delete only the entries written under it from the same dashboard. Writes are limited to 30 requests a minute per IP address.

patch/embed/media/{mediaId}/comments/{commentId}

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/embed/media/{mediaId}/comments/{commentId}
  • Auth: none required

Path parameters

mediaIdstring required

Id of the media file. Trimmed, then 1 to 64 characters from A-Z, a-z, 0-9, _ and - (pattern ^[A-Za-z0-9_-]{1,64}$). Anything else returns 400.

commentIdstring required

Id of the comment. Trimmed, then 1 to 64 characters from A-Z, a-z, 0-9, _ and - (pattern ^[A-Za-z0-9_-]{1,64}$). Anything else returns 400.

Query parameters

tokenstring required

The share link token of a dashboard, or of a media or folder embed on the read routes. Up to 200 characters.

Request body

reviewerNamestring required

The name you write as: one of annotationSettings.reviewers, or any name when allowOtherReviewer is true. Chosen by the link holder and not authenticated. Trimmed; a listed name in another case is stored with the listed spelling. Required.

bodystring required

New text. Author only. Comment text. Trimmed, then 1 to 5,000 characters.

Response

Success

status'success'

success on every 2xx response.

Changes

No recorded changes to this operation across all 2 revisions of this API.