POST api/v1.0/Blogs/RecommendBlog?blogKey={blogKey}

Adds a recommendation for the specified Blog.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
blogKey

BlogKey for the Blog to recommend.

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Details about the Recommendation.

BlogRating
NameDescriptionTypeAdditional information
DocumentKey

globally unique identifier

None.
RatingMode

string

None.
RatedByContact

ContactConcise

None.
RatingValue

decimal number

None.

Response Formats

application/json, text/json

Sample: 
{
  "DocumentKey": "7b3e5691-4685-48ba-8f73-eb939324dd2a",
  "RatingMode": "sample string 2",
  "RatedByContact": {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "9b05afe3-fc4b-4fdb-ba96-e47e1650ebf7",
    "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-10-29T07:20:22.212967Z",
    "UpdatedByContactKey": "f1859047-451d-452a-9989-760905be9846",
    "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-10-29T07:20:22.212967Z"
  },
  "RatingValue": 3.0
}

application/xml, text/xml

Sample: 
<BlogRating xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise">
  <DocumentKey>7b3e5691-4685-48ba-8f73-eb939324dd2a</DocumentKey>
  <RatedByContact>
    <AMSDirectoryOptOut>true</AMSDirectoryOptOut>
    <AgreedToTermsDateTime>2025-10-29T03:20:22.212967-04:00</AgreedToTermsDateTime>
    <CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey>
    <CompanyName>sample string 12</CompanyName>
    <CompanyTitle>sample string 13</CompanyTitle>
    <ContactKey>9b05afe3-fc4b-4fdb-ba96-e47e1650ebf7</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>f1859047-451d-452a-9989-760905be9846</UpdatedByContactKey>
    <UpdatedOn>2025-10-29T03:20:22.212967-04:00</UpdatedOn>
  </RatedByContact>
  <RatingMode>sample string 2</RatingMode>
  <RatingValue>3</RatingValue>
</BlogRating>