Back

PUT comments/{id}?tz={tz}

Update a Comment.

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
id globally unique identifier Required

Guid ID of the comment to be updated.
tz string

Optional parameter to set time zone information.

Body Parameters (Comment)

This object takes all the parameters needed to update a comment.

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID globally unique identifier Required on Update

ID of the given comment.
AncestorID globally unique identifier Required on Create

Ancestor of the given comment.
Post string Required

Contents of the given comment.
UserID globally unique identifier ReadOnly

ID of the user that posted the given comment.
PostDate date ReadOnly

Date the given comment was created.
SiteID globally unique identifier ReadOnly

ID of the site for the given comment.
IndividualFullName string ReadOnly

Full name of the individual that created the given comment.
IndividualID globally unique identifier ReadOnly

ID of the individual that created the given comment.
UserName string ReadOnly

User name of the individual that created the given comment.

Request Formats

application/xml, text/xml

Sample
<Comment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>cba24d26-2d3f-40ba-a8ed-426c7cbbc3d1</ID>
  <AncestorID>f7fbae60-6b38-4205-bb90-c9a7bc7ed570</AncestorID>
  <Post>sample string 1</Post>
</Comment>

application/json, text/json

Sample
{
  "ID": "cba24d26-2d3f-40ba-a8ed-426c7cbbc3d1",
  "AncestorID": "f7fbae60-6b38-4205-bb90-c9a7bc7ed570",
  "Post": "sample string 1"
}

Response Information

Resource Description (Comment)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID globally unique identifier Required on Update

ID of the given comment.
AncestorID globally unique identifier Required on Create

Ancestor of the given comment.
Post string Required

Contents of the given comment.
UserID globally unique identifier ReadOnly

ID of the user that posted the given comment.
PostDate date ReadOnly

Date the given comment was created.
SiteID globally unique identifier ReadOnly

ID of the site for the given comment.
IndividualFullName string ReadOnly

Full name of the individual that created the given comment.
IndividualID globally unique identifier ReadOnly

ID of the individual that created the given comment.
UserName string ReadOnly

User name of the individual that created the given comment.

Response Formats

application/xml, text/xml

Sample
<Comment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>fc8bedac-454a-4381-96f0-8836b1e426ab</ID>
  <AncestorID>ea5964ef-dc14-4d0b-af59-a9dcdb570d5c</AncestorID>
  <UserID>382ecf30-70c0-49d1-b69d-5eca8f73a1cd</UserID>
  <Post>sample string 1</Post>
  <PostDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-05-20T08:28:06.1994529Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </PostDate>
  <SiteID>89744ab0-f40f-4497-9aa5-9cad9d38100c</SiteID>
  <IndividualFullName>sample string 2</IndividualFullName>
  <IndividualID>aef46dbc-4999-4fd0-838f-036b802c4747</IndividualID>
  <UserName>sample string 3</UserName>
</Comment>

application/json, text/json

Sample
{
  "ID": "fc8bedac-454a-4381-96f0-8836b1e426ab",
  "AncestorID": "ea5964ef-dc14-4d0b-af59-a9dcdb570d5c",
  "UserID": "382ecf30-70c0-49d1-b69d-5eca8f73a1cd",
  "Post": "sample string 1",
  "PostDate": "2025-05-20T08:28:06.1994529+00:00",
  "SiteID": "89744ab0-f40f-4497-9aa5-9cad9d38100c",
  "IndividualFullName": "sample string 2",
  "IndividualID": "aef46dbc-4999-4fd0-838f-036b802c4747",
  "UserName": "sample string 3"
}