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 28

REST API: Update User Status

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

Ban, unban, activate, deactivate, or delete one or more user accounts. ResponseData is true when the last account acted on was updated. Every failure inside the operation, including an exception, answers 200 with IsError true and the reason in ResponseMessage.

Action takes a word, not a number. Pass one of the lowercase keywords directly as the query value, for example ?Action=deactivate&UserIDCSV=123,456. A numeric value fails, and so does a capitalized one such as Ban.

delete deletes the user and reassigns or removes their content. That is the action the ReassignOption and ReplacementUsername parameters below exist for. It cannot be undone.

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
ActionStringYESQueryThe action to perform: ban, unban, activate, deactivate, or delete, in lowercase. Without a ReassignOption, deactivate marks the account deactivated and leaves its content in place. With a ReassignOption, deactivate reassigns or removes the user's content as ReassignOption says, and so does delete. The delete action also removes the account. The account's two status flags show the result. After a deactivate with no ReassignOption, reading the account returns IsActivated false and IsBanned true. After ban, it returns IsActivated true and IsBanned true. After unban or activate, it returns IsActivated true and IsBanned false. REST API: User Overview lists the four account states.

Optional Parameters

ParameterTypeRequiredLocationDescription
ReasonStringNOQueryReason for the ban or deactivation, stored on the account.
ReassignOptionIntegerNOQueryFor deactivate and delete, what happens to the user's content: 1 = assign it to the anonymous user, 2 = assign it to the user named by ReplacementUsername, 3 = delete it with the user. Default: 0, which for deactivate means a plain deactivation with the content left in place. For delete, 0 deletes nothing and the call answers IsError true (Updating user status failed). A value that is not a whole number is read as 0.
ReplacementUsernameStringNOQueryUsername of the user to reassign the content to, used when ReassignOption is 2. A username no user has deletes nothing, and the call answers IsError true (Updating user status failed).
FieldReplacementsArrayNOBodyJSON array of profile field objects whose values replace the user's when the content is reassigned. Send it as the request body. Default: none.
UserIDCSVStringNOQueryComma-separated user IDs of the accounts to act on. Send this or UsernameCSV, or both; the lists are merged and a value that is not a number is skipped.
UsernameCSVStringNOQueryComma-separated usernames of the accounts to act on. Send this or UserIDCSV; a name that matches no user is skipped.

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/users/status?Action=ban&UserIDCSV=376

Success Response

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

Error Response

{
  "IsError": true,
  "ResponseMessage": "Action parameter cannot be empty."
}

Error Handling

Status CodeLikely CauseNext Action
200 with IsErrorAction is missing, no listed account could be updated, or the operation failed; ResponseMessage says which.Read IsError on every response, not the status code; check Action and the account list.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenNot returned: when the caller lacks the right for the action, the call answers 200 with IsError true; for activate, ResponseMessage reads 403 Forbidden.Read IsError on every response; call as a site administrator.
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