POST api.ashx/v2/comments.{json|xml}
CREATE a comment.
Scopes
Comments › Modify Comments/Threaded Comments comments.comments.modify
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
Body | string | Body of the comment | Required | |||
CommentTypeId | Guid? | Categorization type | Optional | |||
ContentId | Guid? | Either both ContentId and ContentTypeId or ContentUrl are required | Optional | |||
ContentTypeId | Guid? | Either both ContentId and ContentTypeId or ContentUrl are required | Optional | |||
ContentUrl | string | Either ContentUrl or both ContentId and ContentTypeId are required. ContentUrl requires authentication using OAuth. | Optional | |||
CreatedDate | DateTime? | Date and time the comment was created. The current time will be used if not specified. | Optional | |||
ExtendedAttributes | RestExtendedAttributes | Extended Attributes | Optional | |||
IsApproved | bool? | Approved status of the comment | Optional | |||
ParentCommentId | Guid? | CommentId of the parent if replying to a comment | Optional | |||
Url | string | Optional explicit location of this comment | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.post({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/comments.json', data: { 'Body': 'body' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Comment": { "CommentId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "CommentContentTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "ParentCommentId": "fe65240b-044c-4292-9946-f10e0361ecff", "Url": "url", "CommentTypeId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "User": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "Body": "body", "CreatedDate": "2012-01-04T00:00:00", "ReplyCount": 6, "Group": { "AvatarUrl": "avatarurl", "DateCreated": null, "Description": "description", "Key": "key", "Name": "name", "Url": "url", "TotalMembers": null, "HasGroups": true, "GroupCount": null, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": null, "Id": null }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": null, "ContentId": "6cdcf200-3bad-476d-af45-97b52545c337", "ContentTypeId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4", "CreatedDate": "2012-05-02T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": null }, "Id": "44df201a-07e6-42eb-96c7-8ce7ce35aab6" }, "Id": 25 }, "Body": "body", "CreatedDate": "2012-06-04T00:00:00", "ReplyCount": 8, "Group": { "AvatarUrl": "avatarurl", "DateCreated": "2011-05-28T00:00:00", "Description": "description", "Key": "key", "Name": "name", "ParentGroupId": 4, "Url": "url", "TotalMembers": 7, "HasGroups": true, "GroupCount": 27, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [ { "Key": "key", "Value": "value" }, { "Key": "key", "Value": "value" } ], "ContainerId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": { "ContainerId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "ContainerTypeId": "fe65240b-044c-4292-9946-f10e0361ecff", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" }, "Id": 32 }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": null, "Body": "body", "CreatedDate": null, "ReplyCount": 52, "Group": null, "AttachedUrl": "attachedurl", "HasReplies": null, "ContentId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": null, "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f" }, "Id": 19 }, "ContentId": "6cdcf200-3bad-476d-af45-97b52545c337", "ContentTypeId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4", "CreatedDate": "2011-12-09T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": { "ApplicationId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "ApplicationTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Container": { "ContainerId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "ContainerTypeId": "fe65240b-044c-4292-9946-f10e0361ecff", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" } } }, "Id": "2d525bad-c4df-470d-a193-a1c6d66e5c3e" }, "Id": 112 }, "Body": "body", "CreatedDate": "2012-03-29T00:00:00", "UpdatedDate": "2012-04-19T00:00:00", "UpdatedUserId": 61, "SortOrder": 18, "IsApproved": true, "IsFeatured": true, "IPAddress": "ipaddress", "ReplyCount": 76, "TotalVotes": 6, "Score": 25, "YesVotes": 8, "NoVotes": 4, "UserCanModify": true, "UserCanDelete": true, "Content": { "CreatedByUser": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": { "Author": null, "Body": "body", "CreatedDate": null, "ReplyCount": 7, "Group": null, "AttachedUrl": "attachedurl", "HasReplies": null, "ContentId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": null, "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1" }, "Id": 27 }, "Body": "body", "CreatedDate": "2012-01-16T00:00:00", "ReplyCount": 32, "Group": { "AvatarUrl": "avatarurl", "DateCreated": "2012-01-04T00:00:00", "Description": "description", "Key": "key", "Name": "name", "ParentGroupId": 52, "Url": "url", "TotalMembers": 19, "HasGroups": true, "GroupCount": 112, "GroupType": "grouptype", "EnableGroupMessages": true, "EnableContact": true, "SearchUniqueId": "searchuniqueid", "IsEnabled": true, "ExtendedAttributes": [], "ContainerId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4", "Container": { "ContainerId": "6cdcf200-3bad-476d-af45-97b52545c337", "ContainerTypeId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" }, "Id": 61 }, "AttachedUrl": "attachedurl", "HasReplies": true, "ContentId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f", "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78", "Url": "url", "IsPublished": true, "Content": { "CreatedByUser": { "AvatarUrl": "avatarurl", "DisplayName": "displayname", "ProfileUrl": "profileurl", "Username": "username", "CurrentStatus": null, "Id": null }, "ContentId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "ContentTypeId": "fe65240b-044c-4292-9946-f10e0361ecff", "CreatedDate": "2012-05-02T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": { "ApplicationId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e", "ApplicationTypeId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Container": null } }, "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f" }, "Id": 18 }, "ContentId": "e3715662-2528-4ba1-84a7-bfcd9d548f80", "ContentTypeId": "6cdcf200-3bad-476d-af45-97b52545c337", "CreatedDate": "2012-06-04T00:00:00", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Application": { "ApplicationId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4", "ApplicationTypeId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6", "HtmlName": "htmlname", "HtmlDescription": "htmldescription", "Url": "url", "AvatarUrl": "avatarurl", "Container": { "ContainerId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "ContainerTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "HtmlName": "htmlname", "Url": "url", "AvatarUrl": "avatarurl" } } }, "ExtendedAttributes": [ { "Key": "key", "Value": "value" }, { "Key": "key", "Value": "value" } ] }, "Info": [ "string", "string" ], "Warnings": [ "string", "string" ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Info> <Message>string</Message> <Message>string</Message> </Info> <Warnings> <Message>string</Message> <Message>string</Message> </Warnings> <Errors> <Message>string</Message> <Message>string</Message> </Errors> <Comment> <CommentId>49fec544-6df7-4a82-872b-f8be586d5e9e</CommentId> <CommentContentTypeId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</CommentContentTypeId> <ParentCommentId>fe65240b-044c-4292-9946-f10e0361ecff</ParentCommentId> <Url>url</Url> <CommentTypeId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</CommentTypeId> <User> <Id>112</Id> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> <CurrentStatus> <Id>2d525bad-c4df-470d-a193-a1c6d66e5c3e</Id> <Author> <Id>25</Id> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> <CurrentStatus> <Id>44df201a-07e6-42eb-96c7-8ce7ce35aab6</Id> <Author> <Id /> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> </Author> <Body>body</Body> <CreatedDate>2012-01-04T00:00:00</CreatedDate> <ReplyCount>6</ReplyCount> <Group> <Id /> <AvatarUrl>avatarurl</AvatarUrl> <DateCreated /> <Description>description</Description> <Key>key</Key> <Name>name</Name> <Url>url</Url> <TotalMembers /> <HasGroups>true</HasGroups> <GroupCount /> <GroupType>grouptype</GroupType> <EnableGroupMessages>true</EnableGroupMessages> <EnableContact>true</EnableContact> <SearchUniqueId>searchuniqueid</SearchUniqueId> <ExtendedAttributes /> <ContainerId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContainerId> </Group> <AttachedUrl>attachedurl</AttachedUrl> <ContentId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContentId> <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType> <Url>url</Url> <IsPublished>true</IsPublished> <Content> <ContentId>6cdcf200-3bad-476d-af45-97b52545c337</ContentId> <ContentTypeId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContentTypeId> <CreatedDate>2012-05-02T00:00:00</CreatedDate> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Content> </CurrentStatus> </Author> <Body>body</Body> <CreatedDate>2012-06-04T00:00:00</CreatedDate> <ReplyCount>8</ReplyCount> <Group> <Id>32</Id> <AvatarUrl>avatarurl</AvatarUrl> <DateCreated>2011-05-28T00:00:00</DateCreated> <Description>description</Description> <Key>key</Key> <Name>name</Name> <ParentGroupId>4</ParentGroupId> <Url>url</Url> <TotalMembers>7</TotalMembers> <HasGroups>true</HasGroups> <GroupCount>27</GroupCount> <GroupType>grouptype</GroupType> <EnableGroupMessages>true</EnableGroupMessages> <EnableContact>true</EnableContact> <SearchUniqueId>searchuniqueid</SearchUniqueId> <ExtendedAttributes> <key>value</key> <key>value</key> </ExtendedAttributes> <ContainerId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContainerId> <Container> <ContainerId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerId> <ContainerTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerTypeId> <HtmlName>htmlname</HtmlName> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Container> </Group> <AttachedUrl>attachedurl</AttachedUrl> <ContentId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContentId> <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType> <Url>url</Url> <IsPublished>true</IsPublished> <Content> <CreatedByUser> <Id>19</Id> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> <CurrentStatus> <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id> <Body>body</Body> <CreatedDate /> <ReplyCount>52</ReplyCount> <AttachedUrl>attachedurl</AttachedUrl> <ContentId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContentId> <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType> <Url>url</Url> <IsPublished>true</IsPublished> </CurrentStatus> </CreatedByUser> <ContentId>6cdcf200-3bad-476d-af45-97b52545c337</ContentId> <ContentTypeId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContentTypeId> <CreatedDate>2011-12-09T00:00:00</CreatedDate> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> <Application> <ApplicationId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ApplicationId> <ApplicationTypeId>49fec544-6df7-4a82-872b-f8be586d5e9e</ApplicationTypeId> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> <Container> <ContainerId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerId> <ContainerTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerTypeId> <HtmlName>htmlname</HtmlName> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Container> </Application> </Content> </CurrentStatus> </User> <Body>body</Body> <CreatedDate>2012-03-29T00:00:00</CreatedDate> <UpdatedDate>2012-04-19T00:00:00</UpdatedDate> <UpdatedUserId>61</UpdatedUserId> <SortOrder>18</SortOrder> <IsApproved>true</IsApproved> <IsFeatured>true</IsFeatured> <IPAddress>ipaddress</IPAddress> <ReplyCount>76</ReplyCount> <TotalVotes>6</TotalVotes> <Score>25</Score> <YesVotes>8</YesVotes> <NoVotes>4</NoVotes> <UserCanModify>true</UserCanModify> <UserCanDelete>true</UserCanDelete> <Content> <CreatedByUser> <Id>18</Id> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> <CurrentStatus> <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id> <Author> <Id>27</Id> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> <CurrentStatus> <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id> <Body>body</Body> <CreatedDate /> <ReplyCount>7</ReplyCount> <AttachedUrl>attachedurl</AttachedUrl> <ContentId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContentId> <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType> <Url>url</Url> <IsPublished>true</IsPublished> </CurrentStatus> </Author> <Body>body</Body> <CreatedDate>2012-01-16T00:00:00</CreatedDate> <ReplyCount>32</ReplyCount> <Group> <Id>61</Id> <AvatarUrl>avatarurl</AvatarUrl> <DateCreated>2012-01-04T00:00:00</DateCreated> <Description>description</Description> <Key>key</Key> <Name>name</Name> <ParentGroupId>52</ParentGroupId> <Url>url</Url> <TotalMembers>19</TotalMembers> <HasGroups>true</HasGroups> <GroupCount>112</GroupCount> <GroupType>grouptype</GroupType> <EnableGroupMessages>true</EnableGroupMessages> <EnableContact>true</EnableContact> <SearchUniqueId>searchuniqueid</SearchUniqueId> <ExtendedAttributes /> <ContainerId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContainerId> <Container> <ContainerId>6cdcf200-3bad-476d-af45-97b52545c337</ContainerId> <ContainerTypeId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContainerTypeId> <HtmlName>htmlname</HtmlName> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Container> </Group> <AttachedUrl>attachedurl</AttachedUrl> <ContentId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContentId> <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType> <Url>url</Url> <IsPublished>true</IsPublished> <Content> <CreatedByUser> <Id /> <AvatarUrl>avatarurl</AvatarUrl> <DisplayName>displayname</DisplayName> <ProfileUrl>profileurl</ProfileUrl> <Username>username</Username> </CreatedByUser> <ContentId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContentId> <ContentTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ContentTypeId> <CreatedDate>2012-05-02T00:00:00</CreatedDate> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> <Application> <ApplicationId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ApplicationId> <ApplicationTypeId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ApplicationTypeId> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Application> </Content> </CurrentStatus> </CreatedByUser> <ContentId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContentId> <ContentTypeId>6cdcf200-3bad-476d-af45-97b52545c337</ContentTypeId> <CreatedDate>2012-06-04T00:00:00</CreatedDate> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> <Application> <ApplicationId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ApplicationId> <ApplicationTypeId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ApplicationTypeId> <HtmlName>htmlname</HtmlName> <HtmlDescription>htmldescription</HtmlDescription> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> <Container> <ContainerId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContainerId> <ContainerTypeId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerTypeId> <HtmlName>htmlname</HtmlName> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> </Container> </Application> </Content> <ExtendedAttributes> <key>value</key> <key>value</key> </ExtendedAttributes> </Comment> </Response>