Skip to navigation

Restore a person.

Restores the archived account of a student or reviewer at the institution your API key is issued for, so the person can sign in again. An API key can restore students and reviewers only: a person who holds any other role returns 400 validation_failed, and is restored in AwardSpring instead. Restoring a person who is not archived changes nothing and returns the person. An id that names no person at the institution returns 404 person_not_found, naming id in param.

Authentication

X-Spring-API-Keystring
Secret API key issued per institution. Send it on every request.

Path parameters

idstringRequired

The person’s id, as GET /api/v1/people returns it.

Response

OK
objectstring or nullOptionalRead-only

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.

idstring or nullOptional
The stored ID of the person's user record.
first_namestring or nullOptional
last_namestring or nullOptional
emailstring or nullOptional
roleenum or nullOptional

The person’s main role: super_administrator, administrator, department_admin, reviewer, student, recommender, donor, organization or client_service_admin.

roleslist of strings or nullOptional

Every role the person holds: the main role first, then any other role on the same account.

departmentslist of objects or nullOptional

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.

is_archivedbooleanOptional

True when the account is archived: the person cannot sign in until it is restored.

permissionslist of objects or nullOptional

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.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error