Skip to main content
POST
← Employees API Delete employees of the commuting survey by id. The request checks every id and answers 202 Accepted with an ingest job that deletes them in the background (see how bulk ingestion works). Follow it with GET /v2/ingest-jobs/{id} or, for a job submitted with an API key, the ingest_job.finished webhook. The ids are the ones Create Employees (v2) answers, or the ids of List Employees. Deleting an employee deletes their commuting periods, with their emissions, and their survey answers.
Permanent. Deleted employees cannot be recovered. Use dry_run=true first if you are not sure.
Beta. Part of the bulk ingest API, in beta. The contract may still change before general availability.

How it works

  1. The request checks every id. One that does not exist, is deleted, is outside your organization’s perimeter or is repeated rejects the whole request with 422, and nothing is deleted.
  2. The job deletes them in the background, with their commuting periods, the emissions, calculation data and custom column values of those periods, their own custom column values and their survey answers.
  3. When every chunk is done the job is completed (or completed_with_errors). For a job submitted with an API key, ingest_job.finished is sent with "operation": "delete" to the webhook endpoints of the x-organization-id organization.

Request

Headers

string
required
Your API key (see Authentication).
string
required
The organization the employees are deleted for. Its employees, and those of the organizations under it that you can write to (its perimeter), can be deleted.
string
required
1 to 255 characters, one per batch, looked up per organization across every v2 bulk route. Within 24 hours, the same key with the same route and body returns the original job (with Idempotent-Replayed: true); the same key with another body or on another route is 422 IDEMPOTENCY_KEY_REUSED, and while the first request is still being processed 409 IDEMPOTENCY_KEY_IN_PROGRESS. After 24 hours the key is free, and a request with it is a new one. See The Idempotency-Key.

Query Parameters

boolean
default:"false"
Check only: the same 422 for bad ids, nothing deleted, no job; 200 with {"dry_run": true, "submitted": n, "valid": n} when every id is valid. It does not check or store the Idempotency-Key.

Body Parameters

array[uuid]
required
Employee ids, 1 to 5,000, each once.

Response

202 Accepted with the job (entity_type: employees, operation: delete) and a Location header to it. GET /v2/ingest-jobs/{id}/items has one item per employee, in the order sent; an item is failed with DELETE_FAILED when its employee was already gone by the time the job reached it.

Errors

Problem details. Per-id codes in errors[].error_code of a 422 BULK_RECORDS_REJECTED (source_row_index is the position in ids): Request-level errors: 401 for a missing or invalid API key, 403 LOGGED_USER_NOT_MEMBER when the key’s user is not a member of the organization, 422 REQUEST_VALIDATION_FAILED for a malformed body (no ids, more than 5,000, no Idempotency-Key), 422 IDEMPOTENCY_KEY_REUSED, 409 IDEMPOTENCY_KEY_IN_PROGRESS, and 429 beyond the rate limits.

Limits

Create Employees (v2)

Create employees in bulk

List Employees

Find the ids to delete

Get Ingest Job

Follow the deletion

List Job Items

The outcome of each id