POST api/v2.0/Answer/Recommend?answerKey={answerKey}

Acts as a toggle for recommending an answer. A POST request will recommend while DELETE will remove the recommendation. An answer recommendation refers to the answer being "Helpful" in a Q and A thread.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
answerKey

unique identifier for the Answer to recommend/un-recommend

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

The answer for which the requester’s recommendation was added or removed

Answer
NameDescriptionTypeAdditional information
AnswerKey

Unique identifier of the answer.

 globally unique identifier

None.
ParentKey

Unique identifier of the answer's parent question.

 globally unique identifier

None.
IsBestAnswer

True if this answer has been designated as best answer for the root question. False if this answer has not been designated as best answer for the root question.

 boolean

None.
BestAnswerOn

DateTime in UTC when this answer had been designated as best answer for the root question. Omitted when this answer has not been designated as best answer.

 date

None.
Content

HTML Body of the item

 string

None.
PublishedOn

DateTime in UTC when the item was published

 date

None.
Community

Community to which the item was published

 Community

None.
Author

Author to which the item should be attributed

 ContactConcise

None.
Attachments

Attachments included with this item.

 Collection of DocumentAttachment

None.
IsAnonymous

True if author attribution is to indicate item was submitted anonymously, False if the author attribution indicates who authored the item. Omitted when item is attributed to its author.

 boolean

None.
Creator

When item is posted anonymously, indicates the actual author of the item. Omitted when item is attributed to its author.

 ContactConcise

None.
EditedOn

DateTime in UTC when the item was last edited. Omitted if item has not been edited.

 date

None.
EditedBy

Indicates contact that last edited this item. Omitted if item has not been edited.

 ContactConcise

None.
IsModerated

Indicates whether the item is currently moderated. Omitted when the item is not in moderation.

 boolean

None.
RecommendationCount

Number of contacts who have recommended this item.

 integer

None.
HasRecommended

If the current contact has recommended this item

 boolean

None.
Tags

All of the tags indexed for the item. This includes user tags and admin based tags.

 Collection of ItemTagResponse

None.
UserPermissions

Permissions for actions the current user can take on the item.

 Collection of string

None.

Response Formats

application/json, text/json

Sample: 
{
  "AnswerKey": "a29f7ebb-0ec7-4ce4-b43f-36e9418604db",
  "ParentKey": "5b1e1905-5eca-4ebc-bed3-c1c0143568c0",
  "IsBestAnswer": true,
  "BestAnswerOn": "2025-12-31T11:06:49.7232531Z",
  "Content": "sample string 5",
  "PublishedOn": "2025-12-31T11:06:49.7232531Z",
  "Community": null,
  "Author": {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "f73ec00d-b659-4eba-909d-291af265791e",
    "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-12-31T11:06:49.7232531Z",
    "UpdatedByContactKey": "3de10b30-083d-48d9-a286-5ab661d3dae9",
    "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-12-31T11:06:49.7232531Z"
  },
  "Attachments": [
    {
      "DocumentAttachmentKey": "3a3f2459-f56d-461f-a586-da3b843a06b7",
      "DocumentKey": "dc8fad2d-602c-4066-ac18-1f4d3cd35f37",
      "FileName": "sample string 3",
      "UploadedByContact": {
        "LinkToProfile": "sample string 1",
        "PictureUrl": "sample string 2",
        "ContactKey": "f73ec00d-b659-4eba-909d-291af265791e",
        "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-12-31T11:06:49.7232531Z",
        "UpdatedByContactKey": "3de10b30-083d-48d9-a286-5ab661d3dae9",
        "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-12-31T11:06:49.7232531Z"
      },
      "CreatedOn": "2025-12-31T11:06:49.7232531Z",
      "FileExtension": "sample string 5",
      "FileSizeInBytes": 1,
      "Width": 1,
      "Height": 1,
      "DurationSeconds": 1,
      "DownloadUrl": "sample string 6",
      "IconUrl": "sample string 7",
      "Status": "sample string 8"
    },
    {
      "DocumentAttachmentKey": "3a3f2459-f56d-461f-a586-da3b843a06b7",
      "DocumentKey": "dc8fad2d-602c-4066-ac18-1f4d3cd35f37",
      "FileName": "sample string 3",
      "UploadedByContact": {
        "LinkToProfile": "sample string 1",
        "PictureUrl": "sample string 2",
        "ContactKey": "f73ec00d-b659-4eba-909d-291af265791e",
        "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-12-31T11:06:49.7232531Z",
        "UpdatedByContactKey": "3de10b30-083d-48d9-a286-5ab661d3dae9",
        "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-12-31T11:06:49.7232531Z"
      },
      "CreatedOn": "2025-12-31T11:06:49.7232531Z",
      "FileExtension": "sample string 5",
      "FileSizeInBytes": 1,
      "Width": 1,
      "Height": 1,
      "DurationSeconds": 1,
      "DownloadUrl": "sample string 6",
      "IconUrl": "sample string 7",
      "Status": "sample string 8"
    }
  ],
  "IsAnonymous": true,
  "Creator": {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "f73ec00d-b659-4eba-909d-291af265791e",
    "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-12-31T11:06:49.7232531Z",
    "UpdatedByContactKey": "3de10b30-083d-48d9-a286-5ab661d3dae9",
    "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-12-31T11:06:49.7232531Z"
  },
  "EditedOn": "2025-12-31T11:06:49.7232531Z",
  "EditedBy": {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "f73ec00d-b659-4eba-909d-291af265791e",
    "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-12-31T11:06:49.7232531Z",
    "UpdatedByContactKey": "3de10b30-083d-48d9-a286-5ab661d3dae9",
    "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-12-31T11:06:49.7232531Z"
  },
  "IsModerated": true,
  "RecommendationCount": 10,
  "HasRecommended": true,
  "Tags": [
    {
      "Tag": "sample string 1",
      "TagType": "sample string 2"
    },
    {
      "Tag": "sample string 1",
      "TagType": "sample string 2"
    }
  ],
  "UserPermissions": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.