HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Admin / Update

Experimental endpoint — not yet a stable contract. This resource 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.

Update an administrator of any type. A property left out of the request is unchanged, and null clears an optional property. A request without roleId never changes the administrator's role. The status is changed only through the activate and deactivate actions.

The API token's administrator may update an administrator only when an administrator with the same role, permissions and organization could edit that account in the admin panel, with the same scope and role hierarchy rules. An administrator outside the token's scope returns 404 Not Found; an administrator the token can see but may not edit returns 403 Forbidden. A refused request changes nothing.

The update writes the same audit log entry as the same edit in the admin panel, attributed to the API token's administrator. Includes are not supported.

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

Administrator ID

Body Params

Experimental endpoint — not yet a stable contract. This resource 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.

A property left out of the request is unchanged. null clears an optional property.

email, password, status, operatorId, partnerId, subOperatorId and installationAndMaintenanceCompanyId cannot be changed: sending any of them, even with null or the current value, is refused with 422 and the error "The {field} field cannot be changed." on that field. Other properties that only appear in the response, such as id, adminType, signInMethods, createdAt and updatedAt, are ignored when sent. Remove email, the organisation IDs (operatorId, partnerId, subOperatorId and installationAndMaintenanceCompanyId) and, for an administrator linked to SSO, name before sending back an administrator returned by a read.

name cannot be null or empty. It cannot be changed for an administrator linked to SSO, because SSO sign-in sets it: sending it is refused with "The name field cannot be changed.". Each whitelistedIps entry must be a valid, distinct IP address, and [] clears the list.

string
length ≤ 255

Display name of the administrator

integer
≥ 1

Admin role ID. Only the roles the admin panel offers for this administrator are accepted, and only roles of the administrator's current adminType; the type cannot be changed. Any other role, including an unknown one, is refused with "The selected roleId is invalid.". Cannot be null.
Cannot be changed for an installation_and_maintenance administrator: sending it is refused with "The roleId field cannot be changed."
A request without roleId never changes the administrator's role.

whitelistedIps
array of strings, unique

IP addresses from which the administrator can sign in to the admin panel. An empty list allows any IP address. Entries are returned exactly as stored, so an entry that is not a valid IP address can appear in a response.

whitelistedIps
string | null

A locale the platform supports. null clears it.

string | null
string | null
string | null

Phone number in international format.

string | null
string | null
string | null
string | null

Region or state.

string | null
enum

ISO 3166-1 alpha-2 country code. null clears it.

string | null
locationIds
array of integers, unique
length ≥ 1

Replaces the locations the site manager manages. Only for partner_site_manager administrators: sending it for any other administrator is refused with "The locationIds field is prohibited.".
Must contain at least one location, and every location must belong to the administrator's partner. Cannot be null.

locationIds
date | null

Date on which the account is set to inactive, in the timezone of the administrator's operator. When set, it must be in the future. null clears it; an empty string is not accepted.
Changing or clearing the date does not activate an inactive account: use the activate action.
Administrators cannot set, clear or extend their own expiration date, and the expiration date of an account that belongs to an API access token, a payment terminal or another integration cannot be changed.

Responses

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