Loading ...

REST API: Add Task List | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Tasks » REST API: Add Task List
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 1

REST API: Add Task List

0 
 /5
0 (0votes)

Add Task List

POST /api/list

Add a task list. 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.
TaskListName Used in the request body The task list name.
TaskListDescription Used in the request body A description of the task list.
SpaceID Used in the request body The unique ID of the space to create the task list in.
IsActive Used in the request body Set to true.

Example Request

POST https://myintranet.communifire.com/api/lists

Body:

{
   "TaskListName": "Employee Onboarding",
   "TaskListDescription": "Tasks for onboarding and orienting new employees.",
   "SpaceID": 11,
   "IsActive": true
}

Example Response

Task list data is returned as ResponseData.

{
   "IsError": false,
   "ResponseMessage": "",
   "ResponseData": {
      "TaskListID": 20,
      "TaskListName": "Employee Onboarding",
      "TaskListDescription": "Tasks for onboarding and orienting new employees.",
      "IsActive": true,
      "SpaceID": 11,
      "DateCreated": "0001-01-01T00:00:00",
      "CanBeDeleted": true,
      "CanBeEdited": true
   }
}

 


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

Wiki Index

Pages

Intranet Software