v1
latestOpenAPI 3.1.02026-07-242735131.1 MBSandbox
Archive employment
Archives an employment, setting its status to archived.
This endpoint is only available in Sandbox and allows partners to clean up test employees during automated E2E testing without requiring Remote manual intervention.
This endpoint will respond with a 404 outside of the Sandbox environment.
delete/v1/sandbox/employments/{employment_id}
Path parameters
employment_idstring required
Employment ID
Headers
Authorizationstring required
Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.
The refresh token needs to have been obtained through the Authorization Code flow.
Response
Success
Example response
{
"data": {
"status": "ok"
}
}