Update Admin

Change or clear field(s) of an existing admin. Returns an admin object.

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

JSON Schema for Body

Use the same JSON schema as documented in the Create Admin API.

You do not need to supply all fields—only the fields included in the request will be updated. To clear a field, explicitly pass null.

Note: When updating an admin, if the role parameter is not explicitly included, the system will default the admin to a pending_admin status. To preserve the admin’s existing role, be sure to include the current role value in the request payload.

422 Errors

Occur in the same scenarios as creating an admin, plus in the additional scenario in which a required field is attempted to be set to null.

Path Params
int32
required

The identifier of the admin to be updated

Body Params
admin
object
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/plain