Bulk Delete Workforce Trainings by Filters

Delete every training record matching a set of filters, guarded by the hash of the list you saw

POST /v1/own_workforce_trainings/bulk-delete-by-filters

Bulk Delete Workforce Trainings by Filters

JavaScript

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<x-api-key>',
    'x-organization-id': '<x-organization-id>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({filter_hash: '<string>'})
};

fetch('https://api.dcycle.io/v1/own_workforce_trainings/bulk-delete-by-filters', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

← Own Workforce API

Delete every training matching a filter set, without collecting ids. Filters go in the query string — the same ones List Workforce Trainings Paginated accepts — and the body carries the filter_hash that list returned.

The filter_hash guard

filter_hash fingerprints the filters that produced a page, including consolidate_group and organization_id[]. Send it back; the server recomputes the fingerprint from the filters on this request. Match, and the delete proceeds over exactly the set you listed. Differ, and it answers 409 Conflict without deleting anything.

That is what stops a client from listing one subsidiary and then, after widening the perimeter, deleting the whole group. It guards against that drift, not against a caller who deliberately sends different filters — the tenant boundary is the organization scoping, not the hash. Take the hash verbatim from the list response.

No filter is required. With none, the delete covers every row of the perimeter the list showed: the header organization, or under consolidate_group the accepted family narrowed by organization_id[] (and the project scope, when it is on). That is the same set the unfiltered list counts in total, so read it before you delete.

Request

Headers

x-api-key · string · required

Your API key for authentication

Example: sk_live_1234567890abcdef

x-organization-id · string · required

Your organization UUID

Example: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Query Parameters

file_id[] · array[string]

Filter by source upload file. The nil UUID matches rows with no file.

created_at_from · datetime

Only rows created at or after this instant

created_at_to · datetime

Only rows created on or before this instant, inclusive

search · string

Free-text search, up to 255 characters

consolidate_group · boolean · default: "false"

Widen the perimeter to the accepted family. Part of the hash.

organization_id[] · array[string]

Narrow a group-view delete to these organizations. Part of the hash.

Body

filter_hash · string · required

The filter_hash from the paginated list response that showed you these rows

Response

Same shape as Bulk Delete Workforce Trainings: success_count, success_ids, failed_count, failed_ids and message.

Example

cURL

curl -X POST "https://api.dcycle.io/v1/own_workforce_trainings/bulk-delete-by-filters?file_id[]=aa11bb22-cc33-4d44-8e55-ff6677889900" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}" \
  -H "Content-Type: application/json" \
  -d '{"filter_hash": "4e8a1c07d3b95f26"}'

Successful Response

{
  "success_count": 320,
  "success_ids": [
    "… 320 ids in total, abridged here …",
    "3d9b0a11-2c4e-4f6a-8b1d-5e7f9a0c2d4e"],
  "failed_count": 0,
  "failed_ids": [],
  "message": "Deleted 320 training records"
}

Common Errors

401 Unauthorized

Cause: the key is invalid, or it does not belong to the organization in x-organization-id — the two are looked up as a pair. A request carrying no credentials at all answers AUTH_REQUIRED instead.

{
  "detail": "Invalid API key for organization",
  "code": "INVALID_API_KEY"
}

403 Forbidden

Cause: the key’s owner is not an enabled member of the organization, or their role cannot write.

{
  "detail": "Logged User is not Member of Organization",
  "code": "LOGGED_USER_NOT_MEMBER"
}

409 Conflict

Cause: filter_hash does not match the filters on this request. Nothing was deleted.

{
  "detail": "Filter hash mismatch. The filters have changed since the list was loaded. Please refresh and try again."
}

Related Endpoints

List trainings paginated

Where filter_hash comes from

Bulk delete by ids

When you already hold the ids