Archive a person.
Archives the account of a student or reviewer at the institution your API key is issued for. The person
cannot sign in until the account is restored; their applications, reviews and everything else are kept.
An API key can archive students and reviewers only: a person who holds any other role, such as an
administrator or a donor, returns 400 validation_failed, and is archived in AwardSpring instead.
Archiving a person who is already archived changes nothing and returns the person. The archive is
recorded under your API key. An id that names no person at the institution returns
404 person_not_found, naming id in param.
Authentication
Path parameters
The person’s id, as GET /api/v1/people returns it.
Response
Stripe-style resource discriminator. Stable, snake_case string naming the resource type. Serialized first so it reads as the leading field of every V1 resource body.
The person’s main role: super_administrator, administrator, department_admin,
reviewer, student, recommender, donor, organization or
client_service_admin.
Every role the person holds: the main role first, then any other role on the same account.
The departments an administrator is limited to. An administrator with departments works only with what
belongs to those departments. An empty list means the person is not limited to departments, except for a
department_admin, who is always limited and reaches no department until one is listed here.
True when the account is archived: the person cannot sign in until it is restored.
What the administrator may use, as their Permissions tab shows it. Null for anyone the Permissions tab does not manage: Super Administrators, people who are not administrators, and every person at an institution where all administrators have full access.