HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Admin / Activate

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.

Activate the target administrator account, with the same rules as reactivation in the admin panel. The audit log records a manual status change by the API token's administrator.

Activating an active administrator changes nothing, writes no audit log entry and returns 202. Activation is refused with 409 and nothing is changed when:

  • the account belongs to an API access token, a payment terminal or another integration: "The status of this admin account cannot be changed."
  • the expiration date has passed: "The expiration date must be in the future.". Clear or change the date with the update endpoint first.
  • access cleanup from an earlier deactivation is still unfinished: "Activation is pending until the previous access cleanup finishes. Please try again after cleanup completes.". Blocked cleanup is re-armed so the request can be retried.

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