Loading ...

REST API: Add Space User | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Spaces » REST API: Add Space User
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 41

REST API: Add Space User

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

Adds a new user to the space

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
UserIDIntegerYESBodyUnique identifier for a particular user

Optional Parameters

ParameterTypeRequiredLocationDescription
AsMemberBooleanNOQuerySet to true to add the user as a member at once (a pending request is approved, otherwise the user is added). Set to false to send an invitation instead. When omitted: a site administrator adding someone else, or a user adding themselves, is added directly and ResponseData is the membership status; anyone else sends an invitation.
CheckSpaceModerationBooleanNOQueryWhen true, the space's moderation approval is required before the user is fully added. When false (default), the user is added without moderation approval.

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

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

Request Body

1340

Success Response

{
  "IsError": false,
  "ResponseMessage": "1",
  "ResponseData": "Member"
}

Error Response

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

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (spaceID, userID)Verify the request payload against the required parameters
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
500 Server ErrorInternal failureRetry later
200 with IsErrorUserID is 0: the endpoint answers 200 with ResponseMessage Invalid.Send the user's ID as the JSON body.

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