Comments

Edit, resolve or reopen a comment

Send exactly one of body or isResolved; both or neither returns 400.

  • body edits the text. Only the author can edit a comment; anyone else gets 403 "You can only edit your own comments." No permission is needed to edit your own.
  • isResolved resolves (true) or reopens (false) a thread. It needs the Comments: Update permission (on by default for admins and members) and works only on the first comment of a thread; a reply returns 400.

Errors

  • 400 when the body breaks the rules above or fails validation.
  • 403 when you edit someone else's comment (the error envelope shown), or resolve without the permission ({"status": "failed", "message": "You do not have permission to perform this action"}).
  • 404 when the media or the comment does not exist, or the comment was deleted.
patch/media/{mediaId}/comments/{commentId}

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/media/{mediaId}/comments/{commentId}
  • Auth: API key in header x-speakai-key and API key in header x-access-token

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.

Request body

bodystring

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

isResolvedboolean

true to resolve the thread, false to reopen it. First comment of a thread only.

Response

Success

status'success'

success on every 2xx response.

Changes

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