REST API: Create Bookmark

Anonymous User

Published: 4/26/2019

Grace Kamau

Updated: 8/31/2020

0 (0votes)

Create Bookmark

Creates a bookmark of content. Valid for Communifire version 6.0 and above.

HTTP Method

POST

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.
ContentID	Used in the request URL	Unique identifier for particular content.
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 body	REST API: System Entity Types Refers to the entity type id of the content.

Example URL: https://your-community.com/api/content/170/bookmarks

{
  "Title": "Blogging",
  "Description":"Article on blogging",
  "Entitytype":3
}

Here is an example of JSON data returned from the API call.

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": 22
}

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