Deactivates a system admin or multi-admin account.

Access: PEO admin users only.

The endpoint marks the requested admin account as inactive, triggers the standard admin-updated webhook notification, and returns the refreshed admin detail.

This route-driven PATCH action does not accept a request body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

PEO admin user identifier from the route.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

Responses

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json