IVSWikiBlue: Created page with "This API call will update an existing comment by its ID. ===Resource URL===

http://valt.example.com/api/v3/comment/update/{id}

''Replace {id} with the actual ID nu..."

2026-06-11T20:34:30Z

Created page with "This API call will update an existing comment by its ID. ===Resource URL=== <pre>http://valt.example.com/api/v3/comment/update/{id}</pre> ''Replace {id} with the actual ID nu..."

New page

This API call will update an existing comment by its ID.

===Resource URL===
<pre>http://valt.example.com/api/v3/comment/update/{id}</pre>
''Replace {id} with the actual ID number of the comment.''

===Resource Information===
{|class="wikitable"
|'''Method'''
|POST
|-
|'''Headers'''
|Content-Type: application/json<br>''or'' Content-Type: multipart/form-data ''(when attaching files)''
|-
|'''Response Type'''
|JSON
|-
|'''Authentication Required'''
|Yes
|}

===Parameters===
====Path Parameters====
{|class="wikitable"
!Parameter
!Description
!Example
|-
|'''id'''
|The ID of the comment to update.
|42
|}

====Request Body====
The JSON body must be properly formatted. All fields and values should be enclosed in double quotes and separated by a colon. The <code>type</code> and <code>recordId</code> fields are always required.

=====Required Fields=====
{|class="wikitable"
!colspan="2"|Field Name
!Type
!Description
!Example
|-
|colspan="2"|'''type'''
|string
|Comment type. Must be one of: <code>simple</code>, <code>duration</code>, or <code>transcription</code>.
|"simple"
|-
|colspan="2"|'''recordId'''
|string (UUID)
|Unique identifier of the recording associated with the comment.
|"7b931a86-2142-4121-a6f8-2e3197d4c5bf"
|-
|colspan="2"|'''recordTime'''
|int
|Time index in seconds from the beginning of the recording. Required when type is <code>simple</code> or <code>transcription</code>.
|15
|-
|colspan="2"|'''startTime'''
|int
|Start time in seconds from the beginning of the recording. Required when type is <code>duration</code>.
|12
|-
|colspan="2"|'''endTime'''
|int
|End time in seconds from the beginning of the recording. Required when type is <code>duration</code>.
|42
|}

=====Optional Fields=====
{|class="wikitable"
!colspan="2"|Field Name
!Type
!Description
!Example
|-
|colspan="2"|'''message'''
|string
|The updated text content of the comment.
|"Updated comment text"
|-
|colspan="2"|'''audioId'''
|string (UUID)
|Unique identifier for an associated audio recording.
|"8864d73b-a7f3-4412-bda3-d7ef1c1cd2da"
|-
|colspan="2"|'''template'''
|object
|Template attachment for structured comment data. Contains <code>id</code> (int), and optionally <code>data</code> (object) and <code>name</code> (string).
|{"id": 1, "data": {"37": "some value"}, "name": "Entity name"}
|-
|colspan="2"|'''files'''
|array
|New binary file attachments to add. Requires <code>multipart/form-data</code> content type.
|[binFile1, binFile2]
|-
|colspan="2"|'''fileIds'''
|array of int
|IDs of existing file attachments to retain on the comment. Files not listed here will be removed.
|[20, 21]
|-
|colspan="2"|'''color'''
|string
|Name of a color to associate with the comment.
|"red"
|-
|colspan="2"|'''taggedUsers'''
|array
|Array of user IDs to tag in the comment.
|[1, 2]
|-
|colspan="2"|'''taggedUserGroups'''
|array
|Array of user group IDs to tag in the comment.
|[3, 4]
|}

===Response===

{|class="wikitable"
!Code
!Reason
|-
|200
|Comment Updated Successfully
|-
|400
|Invalid Request (See Response for Specific Error)
|-
|401
|Unauthorized
|-
|500
|Internal Server Error
|}

A successful response returns the full updated Comment object:

{|class="wikitable"
|+Comment Object Fields
!Field
!Type
!Description
|-
|'''id'''
|int
|Unique identifier of the comment.
|-
|'''parentId'''
|int or null
|The ID of the parent comment, if applicable. Null if it has no parent.
|-
|'''message'''
|string or null
|The text content of the comment.
|-
|'''recordId'''
|string
|Unique identifier for the associated record.
|-
|'''recordTime'''
|string
|Seconds from the beginning of the associated record.
|-
|'''createdAt'''
|int
|Unix timestamp when the comment was created.
|-
|'''updatedAt'''
|int
|Unix timestamp when the comment was last updated.
|-
|'''author'''
|User object
|The author of the comment. Contains <code>id</code>, <code>username</code>, and <code>displayName</code>.
|-
|'''updatedBy'''
|User object or null
|The user who last updated the comment. Null if never updated.
|-
|'''audioId'''
|string or null
|Unique identifier for the associated audio, if applicable.
|-
|'''template'''
|Template object or null
|Template attachment, if applicable.
|-
|'''files'''
|array
|List of file attachments. Empty array if no files are attached. Each file contains <code>id</code>, <code>name</code>, and <code>size</code> (bytes).
|-
|'''color'''
|string
|Color name associated with the comment.
|-
|'''replies'''
|array
|Array of reply comments.
|-
|'''taggedUsers'''
|array
|Array of users tagged in the comment.
|-
|'''taggedUserGroups'''
|array
|Array of user groups tagged in the comment.
|}

==Examples==
===Simple Text Comment===
====Request====
The sample JSON body below is formatted with line breaks and indentation to make it easier to read. This is '''not''' required.
<pre>https://ivstest1.ad.ipivs.com/api/v3/comment/update/42?access_token=e82632d19c523678fea3d1016c6df9e9</pre>
<nowiki>
{
"type": "simple",
"recordId": "7b931a86-2142-4121-a6f8-2e3197d4c5bf",
"recordTime": 15,
"message": "Updated comment text"
}
</nowiki>

===Duration Marker Comment===
====Request====
<pre>https://ivstest1.ad.ipivs.com/api/v3/comment/update/42?access_token=e82632d19c523678fea3d1016c6df9e9</pre>
<nowiki>
{
"type": "duration",
"recordId": "7b931a86-2142-4121-a6f8-2e3197d4c5bf",
"startTime": 12,
"endTime": 42,
"message": "Updated marker spanning a range"
}
</nowiki>

===Template Comment===
====Request====
<pre>https://ivstest1.ad.ipivs.com/api/v3/comment/update/42?access_token=e82632d19c523678fea3d1016c6df9e9</pre>
<nowiki>
{
"type": "simple",
"recordId": "7b931a86-2142-4121-a6f8-2e3197d4c5bf",
"recordTime": 10,
"template": {
"id": 1,
"data": {
"37": "some value"
},
"name": "Entity name"
}
}
</nowiki>

===Retaining Existing File Attachments===
====Request====
Use <code>fileIds</code> to keep existing files on the comment. Files whose IDs are not included will be removed.
<pre>https://ivstest1.ad.ipivs.com/api/v3/comment/update/42?access_token=e82632d19c523678fea3d1016c6df9e9</pre>
<nowiki>
{
"type": "simple",
"recordId": "7b931a86-2142-4121-a6f8-2e3197d4c5bf",
"recordTime": 15,
"fileIds": [20, 21],
"message": "Updated message with existing files retained"
}
</nowiki>

===Successful Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"id": 42,
"parentId": null,
"message": "Updated comment text",
"recordId": "7b931a86-2142-4121-a6f8-2e3197d4c5bf",
"recordTime": 15,
"audioId": null,
"template": null,
"author": {
"id": 2,
"displayName": "John Smith",
"username": "jsmith"
},
"files": [],
"updatedBy": {
"id": 2,
"displayName": "John Smith",
"username": "jsmith"
},
"color": "red",
"replies": [],
"taggedUsers": [],
"taggedUserGroups": [],
"createdAt": 1737109634,
"updatedAt": 1737111434
}
</nowiki>

===Failure Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"error": {
"code": 500,
"message": "Internal Server Error"
}
}
</nowiki>

API Edit Comment - Revision history

IVSWikiBlue: Created page with "This API call will update an existing comment by its ID. ===Resource URL===
http://valt.example.com/api/v3/comment/update/{id}
''Replace {id} with the actual ID nu..."