Update a Package

This operation allows you to update selection and customizations to a package in a customer account. A package with inherited set to true inherits its proxy from the root proxy. So, a JSON payload with inherited set to true updates the package proxy with the root proxy if the root proxy is set. The isSelected payload element is mandatory for managed and custom packages. isSelected, packageName and contentType payload elements are mandatory for the custom package update payload. For both managed and custom packages, removing a package with isSelected set to false in the payload will result in a loss of customization made previously at the package level. Removing a custom package with isSelected set to false in the payload will result in the deletion (hard delete) of the custom package and all associated titles from this custom package. If the payload contains ONLY isSelected set to true with no other customization fields, the system will remove all previously set customization. If you do not provide a JSON payload, the JSON payload will be set to the default values and customizations made previously will be lost. If you wish to keep your current customizations, please be sure to set the JSON payload accordingly.

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

EBSCO Customer ID

integer
required

List ID

Body Params

JSON payload to update selection and customizations to a package.

This object represents data elements that describe the payload to update values for a package.

string

Package Name

integer

Content Type. Valid values are 0 for all, 1 for aggregated full text, 2 for abstract and index, 3 for ebook, 4 for ejournal, 5 for print, 6 for unknown, 7 for online reference, 8 for streaming media or 9 for mixed content.

boolean
required

Indicates if the packages is selected in a customer's account.

visibility
array of objects

Visibility details for pf,ftf and marc

visibility
string

Field to set the custom description of the package.

string

The url of the package.

boolean

Field to indicate if a full package.

boolean

Indicates if EBSCO is allowed to add titles. If the package type is custom, then allowEbscoToAddTitles will always be set to false.

customCoverage
object

Dates of Coverage

proxy
object

Proxy

packageToken
object

Token

customAltNames
array of objects
length between 0 and 10

Set a list of custom alternate names for the package

customAltNames
string

Set the custom display name for the package

subjectAssociations
array of objects

The list of subjects to associate with the package.

subjectAssociations
boolean

Indicates if the package is freely available.

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
204

The server has successfully fulfilled the PUT request.

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