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": "af45417d-4a0d-4017-afe7-d6b41c9a153e",
  "DocumentKey": "e6926dce-7446-4d30-a074-cdc4c4c55c2f",
  "CreatedOn": "2024-02-27T01:38:48.1277941Z"
}

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>af45417d-4a0d-4017-afe7-d6b41c9a153e</ContactKey>
  <CreatedOn>2024-02-26T20:38:48.1277941-05:00</CreatedOn>
  <DocumentKey>e6926dce-7446-4d30-a074-cdc4c4c55c2f</DocumentKey>
</DocumentFavorite>