Loading ...

REST API: Update Task Followers | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Tasks » REST API: Update Task Followers
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 2

REST API: Update Task Followers

0 
 /5
0 (0votes)

Update Task Followers

POST /api/tasks/followers

Update followers for a certain task. Existing task followers are replaced. Valid for Communifire version 6.0 and above.

Method Details

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.
Follow JSON Used in the request body JSON representing the follow data.
EntityType Used in the request body The entity type ID of task is 39.
EntityID Used in the request body The unique ID of the task.
SpaceID Used in the request body The space ID where the task is located.
UserIDsCSV Used in the request body A comma-separated list of user IDs of people to add as task followers. Existing task followers are replaced.

Example Request

POST https://myintranet.communifire.com/api/tasks/followers

Body:

{
   "EntityType": 39,
   "EntityID": 34,
   "SpaceID": 14,
   "UserIDsCSV": "1010,1009"
}

Example Response

Follow data is returned as ResponseData.

{
   "IsError": false,
   "ResponseMessage": "Task followers updated.",
   "ResponseData": {
      "FollowID": 0,
      "EntityType": 39,
      "EntityID": 34,
      "UserID": 1009,
      "SpaceID": 14,
      "UserIDsCSV": "1010,1009",
      "TenantID": 0
   }
}

 

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

 

Wiki Index

Pages

Intranet Software