Update a Package Category

This operation allows you to edit an existing package category. Only one category can be edited per call. The category name and rank can be changed. A parent category can be changed or assigned/unassigned. Child categories can also be changed or assigned/unassigned and packages can be assigned/unassigned.

A category name cannot be removed or made blank. The maximum number of assignable packages is equal to the number of selected packages a customer owns. A child category rank will always remain 0 regardless of input. If this operation results in a child category becoming a parent category, the rank will remain 0 unless changed by the customer.

For each customer, there is a maximum of 10 parent categories and a maximum of 50 children per parent. A category is classified as a parent if either of these cases are true:

  1. The category has one or more categories assigned as a child of it.
  2. The category has no categories assigned as a child of it and it is not assigned as a child of another category.

A category is classified as a child if it has a parent category assigned. A child category can only have one parent. It cannot be both a child and parent category. The operation will fail if an attempt is made to assign both fields.

If an operation would result in either parent or child category maximums being exceeded, it will fail with an error.

Please Note: You will need an API key to gain access to the API through our interactive documentation. If you require an API key, please contact EBSCO customer support.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Body Params

Data to edit on the existing category

Model used when creating or updating a category

string
required
length between 1 and 300

Name of the category

integer

Id of the category to assign as parent of given category

childIds
array of integers

List of categoryIds that are to be assigned as the children of the category

childIds
listIds
array of integers

Array of listIds that are to be assigned to the category

listIds
integer
1 to 500

Rank of the category

Headers
string
required

Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. You will need an API key to use the interactive documentation. If you require an API key, please contact EBSCO customer support.

Responses
200

OK

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