Loading ...

REST API: Mark Thread As Favorite | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Chat » REST API: Mark Thread As Favorite
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 5

REST API: Mark Thread As Favorite

0 
 /5
0 (0votes)

Mark Thread As Favorite

PUT /api/chat/threads/{threadid}/favorite/status

Mark a thread as favorite. 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
Rquired 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.
IsFavorite Used in the request body Use this property to set your thread as favorite.
Set favorite=True
Unset favorite=False

Example URL: https://your-community.com/api/chat/threads/9/favorite/status

Request JSON sample for marking message as read

true

Response JSON sample where message JSON object is returned as ResponseData

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

{
 "MessageThread": {
  "ThreadID": 9,
  "ThreadURL": "https://your-community.com/chat#/threads/9",
  "ThreadImageURL": "https://your-community.com/assets/Themes/default/images/avatar-default.jpg",
  "ThreadImageDisplayUserID": 0,
  "MessageID": 0,
  "Participants": "Ben Newman",
  "ParticipantsIds": "5, 7",
  "ParticipantUserID": 7,
  "ParticipantOnlineChatStatus": 1,
  "ParticipantChatStatusCssClass": "status-offline",
  "UnreadMessageCount": 0,
  "MessageBody": "No messages yet",
  "MessageBodyHtmlFormatted": "No messages yet",
  "MessageBodyTextFormatted": "No messages yet",
  "MessageBodyTruncated": "No messages yet",
  "StartedByUserID": 5,
  "StartedByUserMediaServerID": 0,
  "LastMessageSenderUserID": 0,
  "IsRead": false,
  "DateSent": "2019-01-04T05:13:03.477Z",
  "DateSentText": "an hour ago",
  "DateCreated": "2019-01-04T05:13:03.477",
  "ParticipantsJsonString": "[{"id":"7","name":"Ben Newman"}]",
  "ThreadTitle": "Ben Newman",
  "ThreadType": 3,
  "ThreadStatus": 1,
  "DateSentWrtUser": "0001-01-01T00:00:00",
  "IsFavorite": true,
  "RoomName": "9",
  "TenantID": 1
 },
"ThreadID": 9
}

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

Wiki Index

Pages

Intranet Software