[BETA] Restore an archived person outside the school

Restore an archived person outside the school (apprenticeship master, tutor, parent) by their Edusign id. Only the archived status changes: the record comes back with its data, its links to students, its company and its portal access, and absence reports reach it again. Restore it rather than creating a new record: schools already hold dozens of records for one person.

An unknown id, or one belonging to another school, answers 404 EXTERNAL_NOT_FOUND and changes nothing; a record that is active answers 409 EXTERNAL_NOT_ARCHIVED. When another ACTIVE record of the school holds the same email address, the restore is refused with 409 EXTERNAL_ALREADY_EXISTS and that record’s id under errors[0].context.existingExternalId, so the caller uses it instead; nothing is restored.

Fires the on_external_unarchived webhook ({ externalId }) once per successful restore, asynchronously; a delivery failure never changes this response.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 40

Edusign identifier of the external (varchar(40), not a ULID)

Responses

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