Loading ...

REST API: Update Space | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Spaces » REST API: Update Space
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 42

REST API: Update Space

0 
 /5
0 (0votes)
Open API Guide
PUT/api/spaces/{spaceid}

Edit the details of an existing Space. Change descriptions, rename teams, or adjust security settings as needs evolve. Use this for programmatic site maintenance and keeping your groups up-to-date. ResponseMessage is the string True when the space was saved and ResponseData is the SpaceID.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.
Content-TypeYESapplication/jsonMust be set to application/json

Required Parameters

ParameterTypeRequiredLocationDescription
SpaceIDIntegerYESPathUnique identifier for a particular space
Space JSONStringYESBodyThis 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

ParameterTypeRequiredLocationDescription
SpaceNameStringNOBodyUnique name for a space
DescriptionStringNOBodySummary text displayed on the space landing page, describing the space's purpose to members.
EnableArticlesBooleanNOBodySet "articles" module on/off
EnableBlogsBooleanNOBodySet "blogs" module on/off
EnableEventsBooleanNOBodySet "events" module on/off
EnableFilesBooleanNOBodySet "files" module on/off
EnableForumsBooleanNOBodySet "forums" module on/off
EnableIssueTrackerBooleanNOBodySet "issues" module on/off
EnablePhotosBooleanNOBodySet "photos" module on/off
EnableVideosBooleanNOBodySet "videos" module on/off
EnableWikiBooleanNOBodySet "wiki" module on/off
SpaceVisibilityIntegerNOBodyIt defines the visibility of the space. Accepted values are: Private = 0, Public = 1, Isolated = 3.
IsFeaturedBooleanNOBodyMake the space featured
IsArticleWorkflowActiveBooleanNOBodySet "article" workflow on/off
IsBlogWorkflowActiveBooleanNOBodySet "blog" workflow on/off
IsEventWorkflowActiveBooleanNOBodySet "event" workflow on/off
IsFileWorkflowActiveBooleanNOBodySet "file" workflow on/off
IsForumWorkflowActiveBooleanNOBodySet "forum" workflow on/off
IsPhotoWorkFlowActiveBooleanNOBodySet "photo" workflow on/off
IsVideoWorkFlowActiveBooleanNOBodySet "video" workflow on/off
IsWikiWorkflowActiveBooleanNOBodySet "wiki" workflow on/off
MembershipTypeIntegerNOBodySpecifies the space moderation. Accepted values are: Unmoderated = 0, Moderated = 1.
ParentSpaceIDIntegerNOBodyUnique ID of the parent space
StatusIDIntegerNOBodyStatus of the space, an EntityStatus value: Published = 1, Declined = 3.

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/spaces/187

Request Body

{
  "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."
}

Success Response

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

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad Requestspaceid in the path is not an integer, or the body is not a JSON object.Send a numeric SpaceID and a JSON object body.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorNo space has that ID (the endpoint merges into the result without checking), or another internal failure.Check the SpaceID, then retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages