HomeGuidesAPI ReferencePlanSource.com
API Reference

/administrator/{id}/disable

put
https://api.plansource.com/admin/v2/administrator//disable

Disable an administrator account.

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

The ID of the administrator to update or 1.The API currently uses the payload's user_name to look up the administrator.

Body Params
user
object
roles
array of strings
required

List of role lookup_codes available to the logged_in API user.

roles*
organization_codes
array of strings
required

List of one or more organization codes the administrator has access or belongs to.

organization_codes*
string
enum

The administrator user type - organization administrator or master administrator.

Allowed:
Responses

Updated 9 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago