Loading ...

REST API: Update Space Image | Axero Documentation

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

REST API: Update Space Image

0 
 /5
0 (0votes)
Open API Guide
POST/api/spaces/{SpaceID}/image

Set or replace a space's image from the raw bytes of the request body. ResponseData is the result name: ToBePublished when the image was saves, otherwise Error, including when the body is empty, which is why a request without an image answers 200.

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
Image StreamFile StreamYESBodySend the byte stream of the image you want to set as the space image
SpaceIDIntegerYESPathUnique identifier for a particular space

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/octet-stream

Request URL

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

Request Body

To set or replace the banner image for a space (displayed at the top of the space landing page) using Postman:

  1. In Postman, select the Body tab
  2. Choose binary
  3. Click Select File and choose your image (JPG, PNG, or GIF)

Success Response

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

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.Send the space's numeric ID.
401 UnauthorizedMissing or invalid Bearer tokenCheck token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissionsConfirm the user has the required roles for this action.

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