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.

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)

string

New password meeting security requirements. If provided, passwordConfirmation is required.

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 about 1 month 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 about 1 month ago

Did this page help you?