Prembly
GuidesAPI Reference
Background ChecksPackagesDelete a package by query DELETE
DELETE
/api/v1/api/bgc/packages/

Deletes a custom package identified by the package_id query parameter.

This is an alternative spelling of DELETE /packages/{pk}/ and behaves identically. Prefer the path form.

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Query Parameters

package_id*string

Package UUID to delete.

Formatuuid

Response Body

application/json

curl -X DELETE "https://example.com/api/v1/api/bgc/packages/?package_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": {},  "status": true,  "message": "Request successful.",  "errors": {},  "meta": {    "timestamp": "2019-08-24T14:15:22Z",    "version": "v1",    "request_id": "string"  },  "pagination": {    "page": 0,    "page_size": 0,    "total_pages": 0,    "total_items": 0  }}
Response Codes & Statuses: Prembly API responses include custom response_code values (e.g., 00 Success, 01 Not Found, 02 Unavailable).
View Response Codes Guide
Prembly Slack Community

Join our developer Slack channel for real-time integration support, engineering updates, and direct Q&A with the Prembly team.

Join Slack Channel

Create a package POST

Creates a custom package bundling the check types you select. The package then becomes selectable when creating candidate requests. Package names must be unique within your organisation.

Get a package GET

Returns a single package with the check types it bundles.