HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference
Terms of Use

Partner / Admin / Update

patch
https://{tenantUrl}/public-api/resources/partners/v2.0//admins/

Update an existing partner administrator.

All fields are optional. Only provided fields are updated.
For partnerSiteManager, locationIds can be updated to change managed locations.

Changing email to an address on an AMPECO domain (ampeco.com, ampeco.global, ampeco.tech) is refused with a 422 validation error: "Email addresses on AMPECO domains can only be assigned by AMPECO staff." An administrator whose current address is already on an AMPECO domain can keep it.

Required permission: Admins.update

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

Partner ID

integer
required

Partner administrator ID

Body Params
string
length ≤ 255

Name of the administrator

string
length ≤ 255

Email address of the administrator (must remain unique).
Changing it to an address on an AMPECO domain (ampeco.com, ampeco.global, ampeco.tech) is refused with a 422: "Email addresses on AMPECO domains can only be assigned by AMPECO staff."

string

New password with a minimum length of 6 characters. If provided, it must match passwordConfirmation.

string

Must match the password field when password is provided

integer

Role ID (must be valid for the admin's current type)

string | null

Locale code for the administrator

whitelistedIps
array of strings

List of IP addresses for UI access restriction (replaces existing list)

whitelistedIps
locationIds
array of integers

Location IDs the administrator can manage. Only applicable for partnerSiteManager type.

locationIds
Responses

Updated 5 months ago

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

Updated 5 months ago

Did this page help you?