Loading ...

REST API: Bulk Add Users to Spaces | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Spaces » REST API: Bulk Add Users to Spaces
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 4

REST API: Bulk Add Users to Spaces

0 
 /5
0 (0votes)

Bulk add users to spaces

POST /api/spaces/users

Adds multiple users to several spaces. 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.
UserIDCSV Used in the request URL (see below)
 A comma-separated list of user IDs.
SpaceIDCSV Used in the request URL (see below)
 A comma-separated list of space IDs.

Example URL to POST: http://your-community.com/api/spaces/users?userIDCSV=194,199,203&spaceIDCSV=5,6

Response JSON sample where user and space count are returned as ResponseData

{
   "IsError":false,
   "ResponseMessage":"",
   "ResponseData":{
      "userCount":2,
      "spaceCount":2
   }
}

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

Wiki Index

Pages

Intranet Software