POST api/v1.0/Blogs/AddComment?blogKey={blogKey}
Add a new Comment to a Blog.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| blogKey |
Key of the Blog being commented on. |
globally unique identifier |
Required |
Body Parameters
The text for the Blog Comment.
CommentRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| CommentBody | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"CommentBody": "sample string 1"
}
application/xml, text/xml
Sample:
<CommentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Request"> <CommentBody>sample string 1</CommentBody> </CommentRequest>
Response Information
Resource Description
True if successful.
Comment| Name | Description | Type | Additional information |
|---|---|---|---|
| CommentKey |
The unique identifier for the comment |
globally unique identifier |
None. |
| CommentBody |
The text body of the comment |
string |
None. |
| CommentAuthor |
Metadata pertaining to the user who created the comment |
ContactConcise |
None. |
| IsOfficial |
A single comment for an item can be marked as the official comment, and is generally displayed as the top comment/pinned. |
boolean |
None. |
| ItemKey |
The unique identifier for the comment's parent content item |
globally unique identifier |
None. |
| CreatedOn |
The date that the comment was created |
date |
None. |
| UpdatedOn |
The date that the comment was last updated |
date |
None. |
Response Formats
application/json, text/json
Sample:
{
"CommentKey": "ae78e9ef-c3fb-436c-9d9e-07cdcc1d26e3",
"CommentBody": "sample string 2",
"CommentAuthor": {
"LinkToProfile": "sample string 1",
"PictureUrl": "sample string 2",
"ContactKey": "0360799a-2ad8-4b6e-bc10-f1908cef029e",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"DisplayName": "sample string 6",
"EmailAddress": "sample string 7",
"ContactStatusCode": "sample string 8",
"PrefixCode": "sample string 9",
"UpdatedOn": "2025-11-12T09:48:31.0260098Z",
"UpdatedByContactKey": "41bb79d5-cf60-48ae-88ef-b1c4f9f2ec7b",
"CompanyName": "sample string 12",
"CompanyTitle": "sample string 13",
"SuffixCode": "sample string 14",
"Designation": "sample string 15",
"LegacyContactKey": "sample string 16",
"InformalName": "sample string 17",
"MiddleName": "sample string 18",
"IsCompany": true,
"CompanyLegacyContactKey": "sample string 20",
"AMSDirectoryOptOut": true,
"HLDirectoryOptOut": true,
"HLContactMeOptOut": true,
"LargePictureUrl": "sample string 24",
"AgreedToTermsDateTime": "2025-11-12T09:48:31.0260098Z"
},
"IsOfficial": true,
"ItemKey": "8b69c029-c6c8-441f-831c-6ae3e43f3e32",
"CreatedOn": "2025-11-12T09:48:31.0260098Z",
"UpdatedOn": "2025-11-12T09:48:31.0260098Z"
}
application/xml, text/xml
Sample:
<Comment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise">
<CommentAuthor>
<AMSDirectoryOptOut>true</AMSDirectoryOptOut>
<AgreedToTermsDateTime>2025-11-12T04:48:31.0260098-05:00</AgreedToTermsDateTime>
<CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey>
<CompanyName>sample string 12</CompanyName>
<CompanyTitle>sample string 13</CompanyTitle>
<ContactKey>0360799a-2ad8-4b6e-bc10-f1908cef029e</ContactKey>
<ContactStatusCode>sample string 8</ContactStatusCode>
<Designation>sample string 15</Designation>
<DisplayName>sample string 6</DisplayName>
<EmailAddress>sample string 7</EmailAddress>
<FirstName>sample string 4</FirstName>
<HLContactMeOptOut>true</HLContactMeOptOut>
<HLDirectoryOptOut>true</HLDirectoryOptOut>
<InformalName>sample string 17</InformalName>
<IsCompany>true</IsCompany>
<LargePictureUrl>sample string 24</LargePictureUrl>
<LastName>sample string 5</LastName>
<LegacyContactKey>sample string 16</LegacyContactKey>
<LinkToProfile>sample string 1</LinkToProfile>
<MiddleName>sample string 18</MiddleName>
<PictureUrl>sample string 2</PictureUrl>
<PrefixCode>sample string 9</PrefixCode>
<SuffixCode>sample string 14</SuffixCode>
<UpdatedByContactKey>41bb79d5-cf60-48ae-88ef-b1c4f9f2ec7b</UpdatedByContactKey>
<UpdatedOn>2025-11-12T04:48:31.0260098-05:00</UpdatedOn>
</CommentAuthor>
<CommentBody>sample string 2</CommentBody>
<CommentKey>ae78e9ef-c3fb-436c-9d9e-07cdcc1d26e3</CommentKey>
<CreatedOn>2025-11-12T04:48:31.0260098-05:00</CreatedOn>
<IsOfficial>true</IsOfficial>
<ItemKey>8b69c029-c6c8-441f-831c-6ae3e43f3e32</ItemKey>
<UpdatedOn>2025-11-12T04:48:31.0260098-05:00</UpdatedOn>
</Comment>