Delete background check packages

post

https://api.hibob.com/v1/hiring/background-checks/packages/delete

Permanently delete specific packages from the partner catalog for the installing company.

Deletes specific packages from the partner catalog for the
installing company without replacing the full catalog.

Semantics:

packageIds is required and must be non-empty.
Blank or duplicate IDs in the same request return 400.
Matching packages are permanently deleted and cannot be selected for new checks.
Unknown IDs are ignored (idempotent).
In-flight checks keep their stored packageId; GET and PATCH on existing checks remain allowed.

Prefer this when removing a subset of packages. Use POST packages with an
omitted/empty catalog when replacing or clearing the full catalog (POST
permanently deletes omitted packages).

OAuth scope: hiring.integrations:write

Responses

204

No content

Language

Credentials

Bearer

OAuth 2.0

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad request — the request body failed validation (for example an unsupported status, blank package id/name, or duplicate package IDs in the same catalog push).

401Unauthorized — the OAuth 2.0 access token is missing, invalid, or expired.

403Forbidden — the authenticated partner app does not have the hiring.integrations:write scope, or the background-check integration is not enabled for the installing company.

429Too many requests — rate limit exceeded. Retry after the delay indicated by the platform partner API / API gateway defaults.

500Internal server error — an unexpected error occurred. Retry with exponential backoff; if the error persists, contact HiBob support with the requestId from the response body.