HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference
Terms of Use

Partner / Admin / Create

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

Create a new administrator for a specific partner.

The administrator type must be either partner or partnerSiteManager.
For partnerSiteManager, locationIds is required and must contain valid location IDs owned by the partner.

An email 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."

Required permission: Admins.create

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

Partner ID

Body Params
string
required
length ≤ 255

Name of the administrator

string
required
length ≤ 255

Email address of the administrator (must be unique across all admins).
Addresses on AMPECO domains (ampeco.com, ampeco.global, ampeco.tech) are refused with a 422: "Email addresses on AMPECO domains can only be assigned by AMPECO staff."

string
required

Password with a minimum length of 6 characters. It must match passwordConfirmation.

string
required

Must match the password field

string
enum
required

Type of partner administrator:

  • partner - Full partner access, uses roles from partner role group
  • partnerSiteManager - Location-restricted access, uses roles from partner site manager role group
Allowed:
integer
required

Role ID (must be valid for the selected adminType)

string | null

Locale code for the administrator

whitelistedIps
array of strings

List of IP addresses allowed for UI access restriction

whitelistedIps
locationIds
array of integers

Location IDs the administrator can manage. Required when adminType is partnerSiteManager.

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?