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": "b8668f11-9ab8-4c99-ac70-8d841fb38231",
  "DocumentKey": "d73c83af-127b-4159-9d86-fe4956af5ce8",
  "CreatedOn": "2026-01-11T12:43:13.0961976Z"
}

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>b8668f11-9ab8-4c99-ac70-8d841fb38231</ContactKey>
  <CreatedOn>2026-01-11T07:43:13.0961976-05:00</CreatedOn>
  <DocumentKey>d73c83af-127b-4159-9d86-fe4956af5ce8</DocumentKey>
</DocumentFavorite>