Alerts5

Attachments8

Auth3

Conversations15

Featured content1

Forums3

Index1

Me6

Media10

Media albums8

Media categories7

Media comments6

Nodes6

OAuth24

oEmbed1

Posts7

Profile posts11

Resource categories7

Resource reviews6

Resource updates4

Resource versions4

Resources10

Search4

Search forums2

Stats1

Threads12

Users10

Users

Delete the specified user

Changed on Mar 18, 2026

Delete the specified user.

delete/users/{id}/

Request

Base URL
https://example.com/api
Auth
- OAuth 2
  Authorization codehttps://example.com/oauth2/authorize
  Token URLhttps://example.com/api/oauth2/token
  Scopesuser:delete
- or API key in header XF-Api-Key
TypeScript
https://skmtc.dev/xenforo-ltd/apis/xenforo-api/docs/users/:id/delete.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

rename_tostring

If specified, the user will be renamed before deletion

Response

OK

successboolean

Changes

Mar 18, 2026e271d0e41f6d Revision changes
- breaking
  the response's property type changed from string to boolean for status
- warning
  deleted the path request parameter id
- info
  api operation id delete_users_id_ removed and replaced with deleteUsersId
- info
  the endpoint scheme security XF-Api-Key was added to the API
- info
  the endpoint scheme security XF-OAuth2 was added to the API
- info
  added the new optional header request parameter XF-Api-User to all path's operations
- info
  added the new optional query request parameter api_bypass_permissions to all path's operations
Feb 3, 2026fc0a40f3b859 Revision changes
- breaking
  added the new path request parameter id
- breaking
  the response's property type changed from boolean to string for status
- warning
  the optional response header XF-Latest-Api-Version removed for the status 200
- warning
  the optional response header XF-Request-User removed for the status 200
- warning
  the optional response header XF-Request-User-Extras removed for the status 200
- warning
  the optional response header XF-Used-Api-Version removed for the status 200
- info
  api operation id deleteUsersId removed and replaced with delete_users_id_
- info
  the endpoint scheme security XF-Api-Key was removed from the API
- info
  the endpoint scheme security XF-OAuth2 was removed from the API

Operation history