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": "aa3875ec-d471-4028-8ca7-1271f750a79b",
  "DocumentKey": "1e82ca8f-272d-43eb-841a-912342deb5ec",
  "CreatedOn": "2022-12-01T16:12:45.1848338Z"
}

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>aa3875ec-d471-4028-8ca7-1271f750a79b</ContactKey>
  <CreatedOn>2022-12-01T11:12:45.1848338-05:00</CreatedOn>
  <DocumentKey>1e82ca8f-272d-43eb-841a-912342deb5ec</DocumentKey>
</DocumentFavorite>