POST api/v2.0/ResourceLibrary/AddToFavorites?documentKey={documentKey}

Add the specified Document to the Authenticated User's Favorite List.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
documentKey

DocumentKey of a Document.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

DocumentFavorite
NameDescriptionTypeAdditional information
ContactKey

globally unique identifier

None.

DocumentKey

globally unique identifier

None.

CreatedOn

date

None.

Response Formats

application/json, text/json

Sample:
{
  "ContactKey": "c1952119-5912-461b-8ca0-e65216e60062",
  "DocumentKey": "aa534895-d787-46eb-8204-aacc0ceea569",
  "CreatedOn": "2025-02-08T10:35:20.4606524Z"
}

application/xml, text/xml

Sample:
<DocumentFavorite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.ResourceLibrary">
  <ContactKey>c1952119-5912-461b-8ca0-e65216e60062</ContactKey>
  <CreatedOn>2025-02-08T05:35:20.4606524-05:00</CreatedOn>
  <DocumentKey>aa534895-d787-46eb-8204-aacc0ceea569</DocumentKey>
</DocumentFavorite>