Loading ...

REST API: Update User Status | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Users » REST API: Update User Status
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 22

REST API: Update User Status

0 
 /5
0 (0votes)
Open API Guide
PUT/api/users/status

Supports the synchronization and modification of update status properties via the API.

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
ActionIntegerYESQuerySpecifies the action to be performed on the user: ban, unban, activate, deactivate
UserIDCSV or UsernameCSVStringYESQueryUnique identifier for a list of users

Optional Parameters

ParameterTypeRequiredLocationDescription
ReasonStringNOQueryProviding additional context of a user's ban or deactivation
ReassignOptionIntegerNOQueryAllows the transfer of content to another user, or deleting the content with a user. Option values are: 1, 2, 3 1 = Assign content to anonymous 2 = Assign content to another user 3 = Delete content with user Note: Only integer values accepted
ReplacementUsernameStringNOQueryUsername of the user to reassign the content to

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/users/status?Action=string&UserIDCSV or UsernameCSV=string

Success Response

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

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (fieldReplacements)Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
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