Update a Title in a Package

This operation allows you to update selection status, proxy value or coverage customizations for a title within a package in a customer EPKB account. A title with inherited set to true inherits its proxy from the root proxy. So, a JSON payload with inherited set to true updates the title proxy with the root proxy if the root proxy is set. The isSelected payload element is mandatory for managed and custom titles. The titleName and pubType payload elements are mandatory for the custom title update payload. For both managed and custom titles, removing a title with isSelected set to false in the payload will result in a loss of customization made previously at the title level. Removing a custom title with isSelected set to false in the payload will result in the deletion (hard delete) of the custom title from the 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. This endpoint has been deprecated. Please use this endpoint instead: /v2/{custid}/lists/{listid}/titles/{kbid}

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

Vendor ID

integer
required

Package ID

integer
required

Title ID

string
required

EBSCO Customer ID

Body Params

JSON payload to update a title within a package. The isSelected, titleName and pubType payload elements are mandatory for the custom title payload.

This object represents data elements to update a title within a package.

boolean
required

Indicates if selected in a customer's account.

string

Title Name

string

Type of publication. Valid values are journal, newsletter, report, proceedings, website, newspaper, unspecified, book, bookseries, database, thesisdissertation, streamingaudio, streamingvideo, and audiobook.

string

Publisher Name

boolean

Field to indicate if title is peer reviewed.

string

Title Edition

string

Description

string

URL

customCoverageList
array of objects

Custom Coverage List

customCoverageList
boolean

Field to indicate if title is hidden.

string

Coverage Statement

customEmbargoPeriod
object

Embargo Period

string

User Defined Field 1

string

User Defined Field 2

string

User Defined Field 3

string

User Defined Field 4

string

User Defined Field 5

proxy
object

Proxy

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