API Reference

Creates a new system admin or multi-admin account.

post
https://example.com/wep/admins

Access: PEO admin users only.

Full system and PEO full-admin users create accounts with broad system access. Partner-scoped multi-admin users create a new account by cloning their own limited access scope.

Existing platform identities may be paired to the new admin account by matching the submitted email address. When invitation delivery is enabled, the endpoint generates the standard onboarding link and sends it through the business layer.

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

Payload describing the admin account to create.

Request payload for creating a system admin or multi-admin account through the SystemAdmins API.

string | null

Optional first name stored on the admin profile. Maximum length is 35 characters.

string | null

Optional last name stored on the admin profile. Maximum length is 35 characters.

string | null
required

Required sign-in email for the new admin account. The value must be a valid email address and cannot exceed 255 characters.

string | null

Optional initial password for the new login. When omitted, the account can be completed through the standard invitation and set-password flow. Partner-scoped clone creation does not use this field.

boolean | null

Optional flag that sends the standard invitation email when set to true. A value of false or null skips email delivery.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

Responses

Updated about 1 month ago

Language
Credentials
Bearer
jwt
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