Loading ...

REST API: Approve/Decline Space User | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Spaces » REST API: Approve/Decline Space User
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 38

REST API: Approve/Decline Space User

0 
 /5
0 (0votes)
Open API Guide
PUT/api/spaces/{SpaceID}/users/{UserID}/membership/status

Users need approval to join moderated spaces. This join request goes to the space admin; who can approve or decline the request. This can be done by passing "true/false" in the request body for approving/declining user's space join request.

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
SpaceIDIntegerYESPathID of the space which the user wants to join
UserIDIntegerYESPathID of the user who wants to join space
approveBooleanYESBodyA bare JSON boolean in the request body: true to approve the membership request, false to decline it

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/spaces/240/users/1350/membership/status

Request Body

true

Success Response

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

Error Response

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

ImportantA ResponseData value of "true" indicates the approve or decline action completed successfully.

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (spaceID, userID, approve)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 ResponseData falseSpaceID is 0, or the request could not be approved or declined (no pending request for the user, or the caller cannot moderate the space).Check the user has a pending request and that the caller can moderate the space.

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