Favourites API

Favourite Items - Add to favourites / Remove from favourites

OVERVIEW

Add to favourites /  Remove from favourites API

Request URI

PUT /api/4/favourites?contenttype=files&contentid=102&favourite=0

 

Parameter Name Value Description
contentid String  

This the content id of the required content. e.g

blogid for contenttype=blog, taskid for contenttype=tasks
contenttype String  /api/3/favourites?contenttype=files

  • Microblogs
  • Files
  • Wiki
  • Blog
  • Tasks
  • Events
  • Site
  • iSheet
  • Folder
  • SiteHome

favourite

 int

0 : Remove from favourites

1 : Add to favourites

 

Response

If successful, the API returns the 200 status code.

 

If the operation fails, the API will return one of the following error codes

Response codes

 

CODE

MEANING

    201

   Favourite items returned successfully

    400

   Problem with parameters

    401 

   Unauthorized

    403

   Validation failed | Forbidden

    500

   Internal error occurred while returning comments

In case of an error code other than 201, an error object will be returned in the format 

Comments


0 Comments

Last Updated: Jun 09,2023