Register assessment packages

Replace the partner package catalog for the installing company.

Registers or replaces the partner's package catalog for the installing
company. The call is idempotent — safe to retry to refresh names or
descriptions.

Catalog replace semantics:

  • id and name are required and non-blank; description is optional.
  • Duplicate package IDs in the same request return 400.
  • Packages omitted from the POST are soft-archived and cannot be selected for new assessments.
  • An empty packages array archives all packages for that company/app.
  • In-flight assessments keep their stored packageId; GET and PATCH on existing assessments remain allowed.
  • Validation is all-or-nothing — no partial accept.

400 is returned when package id/name are blank

or whitespace-only, or when the request contains duplicate package IDs.

There is no hard maximum package count in v1.

OAuth scope: hiring.integrations:write

Rate limit: default partner API / API gateway limits. See
Rate limiting.

Body Params

Full package catalog for the installing company. Omitted packages are
soft-archived. An empty list archives all packages.

packages
array of objects
required

Packages to keep active for the installing company after this replace.

packages*
Responses
201

Success

Language
Credentials
Bearer
OAuth 2.0
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json