Loading ...

REST API: Set Space Status | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Spaces » REST API: Set Space Status
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 15

REST API: Set Space Status

0 
 /5
0 (0votes)

Set space status

PUT /api/spaces/{spaceid}/status

Sets the status of an existing space specified by Space ID and Status ID. Returns JSON indicating whether or not the specified space status was actually updated. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
PUT
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 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.
SpaceID Used in the request URL (see below) Unique identifier for a particular space.
StatusID Used in the request body Status of the space. Here are the accepted values:
  • Pending Workflow = 0
  • Published = 1
  • Declined = 3

Example URL to PUT: http://your-community.com/api/spaces/3/status

Request JSON sample for updating space status

  
  "1"

Response JSON sample where indicator (true/false) is returned as ResponseData


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


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

Wiki Index

Pages

Intranet Software