Restore an archived employee
const url = 'https://example.com/api/public/v1/employees/restore';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"Id":"example","Email":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/public/v1/employees/restore \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "Id": "example", "Email": "example" }'Takes an employee back out of the archive, addressed by corporate email or by id — the way back when somebody returns. It restores the record, not access: a person who closed their card has to be invited again and has to grant again, which remains theirs alone to do.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Addresses one employee record by either handle. Give exactly one: the corporate email the record was created with, or the id a previous call returned.
object
Examplegenerated
{ "Id": "example", "Email": "example"}Addresses one employee record by either handle. Give exactly one: the corporate email the record was created with, or the id a previous call returned.
object
Examplegenerated
{ "Id": "example", "Email": "example"}Addresses one employee record by either handle. Give exactly one: the corporate email the record was created with, or the id a previous call returned.
object
Examplegenerated
{ "Id": "example", "Email": "example"}Responses
Section titled “Responses”OK
What restoring did — the way back out of the archive, so a person who returns can be invited again. Idempotent, like archiving: restoring an active record succeeds and reports that nothing changed.
object
True when this call restored the record; false when it was not archived.
Example
{ "Status": "NotActivated"}Bad Request
The Integration API’s error shape — RFC 7807 application/problem+json. The Portal API answers
in its own { Error, Details } envelope because one client parses one shape; an external
integrator expects the standard instead.
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Unauthorized
The Integration API’s error shape — RFC 7807 application/problem+json. The Portal API answers
in its own { Error, Details } envelope because one client parses one shape; an external
integrator expects the standard instead.
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
The Integration API’s error shape — RFC 7807 application/problem+json. The Portal API answers
in its own { Error, Details } envelope because one client parses one shape; an external
integrator expects the standard instead.
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}