Archive a person outside the school (apprenticeship master, tutor, parent) by their Edusign id. Archiving is a SOFT delete: nothing is erased — the record, its links to students, its company and its signed documents stay as they are, and POST /externals/:id/restore brings it back as it was. What changes: the record disappears from the students’ contacts and from the tutor portal for this school, absence reports stop being sent to it, and its email address stays reserved (creating or renaming a record onto that address answers 409 EXTERNAL_ARCHIVED_EXISTS with the archived record’s id, so the caller restores it instead of adding a duplicate). GET /externals/:id still returns the record.
An unknown id, or one belonging to another school, answers 404 EXTERNAL_NOT_FOUND and changes nothing; a record that is already archived answers 409 EXTERNAL_ALREADY_ARCHIVED; an id longer than 40 characters answers 400 VALIDATION_ERROR. No other check: archiving never fails because of the record’s email, company or students.
Fires the on_external_archived webhook ({ externalId }) once per successful archive, asynchronously; a delivery failure never changes this response.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||

