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": "d21115df-ce56-4534-bae1-aa1e938339c4",
  "DocumentKey": "7e1a732a-2822-4cdb-b780-62f999e181c3",
  "CreatedOn": "2022-07-04T02:25:50.6893532Z"
}

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>d21115df-ce56-4534-bae1-aa1e938339c4</ContactKey>
  <CreatedOn>2022-07-03T22:25:50.6893532-04:00</CreatedOn>
  <DocumentKey>7e1a732a-2822-4cdb-b780-62f999e181c3</DocumentKey>
</DocumentFavorite>