HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Admin / Deactivate

Experimental endpoint — not yet a stable contract. This action ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.

Deactivate the target administrator account. Deactivation has the same effects as in the admin panel, including when it is run with an API access token: sign-in is blocked, browser sessions are ended, connected applications are revoked, and the audit log records a manual status change by the API token's administrator. A 202 response means the status change was committed; ending sessions and revoking applications continue in the background.

Deactivating an inactive administrator, including one whose expiration date has passed, changes nothing, writes no audit log entry and returns 202.

The status of an account that belongs to an API access token, a payment terminal or another integration cannot be changed: such a request returns 409 with "The status of this admin account cannot be changed.".

The API token's administrator may run this action when an administrator with the same role, permissions and organization could change the target's status in the admin panel. An administrator outside the token's scope returns 404 Not Found. An administrator the token can see but may not change returns 403 Forbidden; this includes the token's own administrator account. A refused request changes nothing.

No request body or includes are supported.

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

Administrator ID

Responses

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