Loading ...

REST API: Create Space | Axero Documentation

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

REST API: Create Space

0 
 /5
0 (0votes)
Open API Guide
POST/api/spaces

Establish a brand new Space for collaboration. This is the first step in creating a new team or project area.

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
Space JSONStringYESBodyThis is JSON that represents a space object that you're creating. This should be of the format seen below in the sample given. The required values in this JSON are given below.
DescriptionStringYESBodySummary text displayed on the space landing page, describing the space's purpose to members.
SpaceNameStringYESBodyUnique name for a space

Optional Parameters

ParameterTypeRequiredLocationDescription
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
IsFeaturedBooleanNOBodyMake the space featured
SpaceVisibilityIntegerNOBodyIt defines the visibility of the space. Accepted values are: Private = 0, Public = 1, Isolated = 3.
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
StatusIDIntegerNOBodyThis is the status of the space. Accepted values are: Pending Workflow = 0, Published = 1, Declined = 3.

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

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

Request Body

{
  "Description": "A collaborative workspace for the engineering team to share knowledge and updates.",
  "SpaceName": "Engineering Hub"
}

Success Response

{
  "IsError": false,
  "ResponseMessage": "ToBePublished",
  "ResponseData": 400
}

Error Response

HTTP 500 with an empty body

Error Handling

Status CodeLikely CauseNext Action
500 Server ErrorA required parameter is missing. The endpoint fails with an empty body instead of reporting the missing value.Verify the request against the required parameters before treating the 500 as a server fault.
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.
400 Bad RequestThe body is empty or not valid JSON.Send a JSON space object.

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