Replaces a custom package in full. Fields omitted from the body are reset, so send the whole package; use PATCH to change part of one.
Changing a package does not alter candidate requests already created from it.
Authorization
ApiKeyAuth In: header
Path Parameters
Package UUID.
uuidTypeScript Definitions
Use the request body type in TypeScript.
Serializer for creating new packages.
Response Body
application/json
curl -X PUT "https://example.com/api/v1/api/bgc/packages/497f6eca-6276-4993-bfeb-53cbbbba6f08/" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "description": "string", "country": "string", "check_types": [ "string" ], "used_system_package": true, "is_saved": true, "allow_candidate_payment": true, "allow_candidate_access_report": true }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "country": "string", "country_code": "string", "check_types": null, "is_active": true, "is_public": true, "created_by": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "first_name": "string", "last_name": "string", "email": "user@example.com", "last_login": "2019-08-24T14:15:22Z" }, "allow_candidate_access_report": true, "allow_candidate_payment": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }, "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_code values (e.g., 00 Success, 01 Not Found, 02 Unavailable).Join our developer Slack channel for real-time integration support, engineering updates, and direct Q&A with the Prembly team.
Join Slack ChannelDelete a package DELETE
Soft-deletes a custom package. Candidate requests already created from it are unaffected.
List system packages GET
Returns the predefined packages Prembly maintains, usable without building your own. Check types are omitted from this list for brevity — fetch a single system package to see what it bundles.