Loading ...

REST API: Set Space Status | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Spaces » REST API: Set Space Status
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 37

REST API: Set Space Status

0 
 /5
0 (0votes)
Open API Guide
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. ResponseData is true when the status was saved; a SpaceID of 0 or less returns false without a lookup.

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
StatusIDIntegerYESBodyNew status of the space, sent as the bare JSON body, an EntityStatus value: Published = 1, Declined = 3. 0 (PendingWorkflow) is refused with 403.

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

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

Request Body

"1"

Success Response

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

Error Response

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

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestSpaceID in the path is not an integer, or the body is missing or not an integer.Send a numeric SpaceID and a bare integer body.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenStatusID is 0 (PendingWorkflow), which cannot be set here because the workflow step would be lost, or the caller cannot manage the space.Send 1 or 3 and check the caller's rights.
500 Server ErrorInternal failure.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