POST api/v1.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": "7ede9741-dacb-42d0-a11a-2e8986bce0ec",
  "DocumentKey": "7e4b79a1-6a40-4b95-9834-5a739f59cde0",
  "CreatedOn": "2025-12-02T23:57:16.2988942Z"
}

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>7ede9741-dacb-42d0-a11a-2e8986bce0ec</ContactKey>
  <CreatedOn>2025-12-02T18:57:16.2988942-05:00</CreatedOn>
  <DocumentKey>7e4b79a1-6a40-4b95-9834-5a739f59cde0</DocumentKey>
</DocumentFavorite>