Loading ...

REST API: Update Bookmark | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Bookmarks » REST API: Update Bookmark
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 3

REST API: Update Bookmark

0 
 /5
0 (0votes)

Update Bookmark

PUT /api/content/{contentID}/bookmarks

Updates an existing Bookmark. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
PUT
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
Title Used in the request body Title of the bookmark.
Description Used in the request body Description of the bookmark.
EntityType Used in the request URL REST API: System Entity Types 
Refers to the entity type id of the content.

Example URL to PUT: https://your-community.com/api/content/170/bookmarks?entitytype=3

Request JSON sample for updating the bookmark - Stringify your JSON data


"{\"Title\": \"Article on blogging\",\"Description\": \"Article on blogging\"}"

Response JSON sample where bookmark JSON object is returned as ResponseData


{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "BookmarkID": 22,
    "EntityID": 170,
    "EntityType": 3,
    "SpaceID": 0,
    "Url": "https://your-community.com/articles/news/170/Blogging",
    "UserID": 21,
    "DateCreated": "2019-04-26T07:17:28.02",
    "SortOrder": 0,
    "Title": "Article on blogging",
    "Description": "Article on blogging",
    "IsExternal": false,
    "BookmarkEntityIconCssClass": "icon-file",
    "TenantID": 1
   }
}

Please Note Your content type that you pass in the header of your request should be 'application/json'.

Wiki Index

Pages

Intranet Software