Loading ...

REST API: Bulk Add Users to Spaces | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Spaces » REST API: Bulk Add Users to Spaces
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 28

REST API: Bulk Add Users to Spaces

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

Adds multiple users to several spaces

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
UserIDCSVStringYESQueryA comma-separated list of user IDs
SpaceIDCSVStringYESQueryA comma-separated list of space IDs

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/spaces/users?userIDCSV=194,199,203&spaceIDCSV=5,6

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "userCount": 1,
    "spaceCount": 1
  }
}

Error Response

{
  "Message": "The requested resource does not support http method 'POST'."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (userIDCSV, spaceIDCSV)Verify the request payload against the required parameters
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenThe caller lacks the Space administration permission (Admin Entity View on spaces).Call with a site administrator token or grant the permission.
500 Server ErrorAn ID in either list is not an integer, or another internal failure.Send numeric IDs; then retry later.
404 or 405A required query parameter was left out, so the request matched a different action or none: the message reads No HTTP resource was found or The requested resource does not support http method.Send every required query parameter; the message is not about the resource.

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