Loading ...

REST API: Update Space | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Spaces » REST API: Update Space
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 20

REST API: Update Space

0 
 /5
0 (0votes)

Update space

PUT /api/spaces/{spaceid}

Updates an existing space with Space ID with the properties as specified by JSON in the request body. 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.
Space JSON Used in the request body This is JSON that represents a space object that you're updating. This should be of the format seen below in the sample given.
Optional Parameters How to use Description
SpaceName Used in the request body Unique name for a space.
Description Used in the request body Description of the space.
EnableArticles Used in the request body Set "articles" module on/off.
EnableBlogs Used in the request body Set "blogs" module on/off.
EnableEvents Used in the request body Set "events" module on/off.
EnableFiles Used in the request body Set "files" module on/off.
EnableForums Used in the request body Set "forums" module on/off.
EnableIssueTracker Used in the request body Set "issues" module on/off.
EnablePhotos Used in the request body Set "photos" module on/off.
EnableVideos Used in the request body Set "videos" module on/off.
EnableWiki Used in the request body Set "wiki" module on/off.
SpaceVisibility Used in the request body It defines the visibility of the space. Accepted values are:
  • Private = 0
  • Public = 1
  • Isolated = 3
IsFeatured Used in the request body Make the space featured
IsArticleWorkflowActive Used in the request body Set "article" workflow on/off.
IsBlogWorkflowActive Used in the request body Set "blog" workflow on/off.
IsEventWorkflowActive Used in the request body Set "event" workflow on/off.
IsFileWorkflowActive Used in the request body Set "file" workflow on/off.
IsForumWorkflowActive Used in the request body Set "forum" workflow on/off.
IsPhotoWorkFlowActive Used in the request body Set "photo" workflow on/off.
IsVideoWorkFlowActive Used in the request body Set "video" workflow on/off.
IsWikiWorkflowActive Used in the request body Set "wiki" workflow on/off.
MembershipType Used in the request body Specifies the space moderation. Accepted values are:
  • Unmoderated = 0
  • Moderated = 1
ParentSpaceID Used in the request body Unique ID of the parent space.
StatusID Used in the request body This is the status of the space. Accepted values are:
  • Pending Workflow = 0
  • Published = 1
  • Declined = 3

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

Request JSON sample for updating a space - Stringify your JSON data


"{
    \"Description\":\"In a support group, members provide each other with various types of help. Members with the same issues can come together for sharing coping strategies, to feel more empowered and for a sense of community.\"
}"

Response JSON sample where Space ID is returned as ResponseData


{
    "IsError":false,
    "ResponseMessage":"True",
    "ResponseData":187
}


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

Wiki Index

Pages

Intranet Software