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 45

REST API: Update Space

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

Update a space. Send only the fields to change; the rest keep their current values. 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 JSONStringYESBodyThe fields to change, as a JSON object (a set of named fields and their values). Each name must match exactly, including case: a name the space does not have, such as description in lowercase, answers 500. A value that cannot be converted sets a true or false field to false and a number field to 0.

Optional Parameters

ParameterTypeRequiredLocationDescription
SpaceNameStringNOBodyNew name for the space. The update does not check whether another space already uses the name.
DescriptionStringNOBodySummary text displayed on the space landing page, describing the space's purpose to members. A JSON list or another value that is not text is saved as its JSON text.
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
SpaceVisibilityIntegerNOBodyVisibility of the space. Accepted values: Private = 0, Public = 1, Isolated = 3. A number outside these values is saved as sent, and a value that is not a number answers 500.
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. A value that is not a number answers 500.
ParentSpaceIDIntegerNOBodyID of the space to move this space under; 0 makes it a top-level space. A value that is not a number also moves the space to the top level.
StatusIDIntegerNOBodyStatus of the space, an EntityStatus value: Published = 1, Declined = 3. A value that is not a number sets the status to 0 (PendingWorkflow).

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

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

Request Body

{
  "Description": "A space where members share updates and answer each other's questions."
}

Success Response

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

Error Response

{
  "Message": "The request is invalid."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad Requestspaceid in the path is not an integer.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 ForbiddenThe caller cannot update spaces site-wide and is not an administrator of this space.Confirm the user has the required roles for this action.
500 Server ErrorThe body is missing or null, names a field the space does not have, gives SpaceVisibility or MembershipType a value that is not a number, or no space has that ID.Check the body and 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