Skip to main content

PatchBookMetadataRequest

PATCH request for partial update of book metadata

Only provided fields will be updated. Absent fields are unchanged. Explicitly null fields will be cleared.

authors object[]

Structured author information as JSON array

  • Array [
  • namestringrequired

    Author's name

    Example: Andy Weir
    roleBookAuthorRole (string)required

    Role of this author

    Possible values: [author, co_author, editor, translator, illustrator, contributor, writer, penciller, inker, colorist, letterer, cover_artist]

    sortNamestring | nullnullable

    Sort name for ordering (e.g., "Weir, Andy")

    Example: Weir, Andy
  • ]
  • awards object[]

    Awards information

  • Array [
  • categorystring | nullnullable

    Award category

    Example: Best Novel
    namestringrequired

    Name of the award

    Example: Hugo Award
    wonbooleanrequired

    Whether the book won (true) or was just nominated (false)

    Example: true
    yearinteger,null<int32>nullable

    Year the award was given/nominated

    Example: 2015
  • ]
  • blackAndWhiteboolean | nullnullable

    Whether the book is black and white

    Example: false
    bookType object
    oneOf
    null
    coloriststring | nullnullable

    Colorist(s) - comma-separated if multiple

    Example: Richmond Lewis
    countinteger,null<int32>nullable

    Total count in series

    Example: 4
    coverArtiststring | nullnullable

    Cover artist(s) - comma-separated if multiple

    Example: David Mazzucchelli
    customMetadataobject | nullnullable

    Custom metadata JSON escape hatch

    dayinteger,null<int32>nullable

    Publication day (1-31)

    Example: 1
    editionstring | nullnullable

    Edition information (e.g., "First Edition", "Revised Edition")

    Example: First Edition
    editorstring | nullnullable

    Editor(s) - comma-separated if multiple

    Example: Dennis O'Neil
    formatDetailstring | nullnullable

    Format details

    Example: Trade Paperback
    genrestring | nullnullable

    Genre

    Example: Superhero
    imprintstring | nullnullable

    Imprint name

    Example: DC Black Label
    inkerstring | nullnullable

    Inker(s) - comma-separated if multiple

    Example: David Mazzucchelli
    isbnsstring | nullnullable

    ISBN(s) - comma-separated if multiple

    Example: 978-1401207526
    languageIsostring | nullnullable

    ISO language code

    Example: en
    lettererstring | nullnullable

    Letterer(s) - comma-separated if multiple

    Example: Todd Klein
    mangaboolean | nullnullable

    Whether the book is manga format

    Example: false
    monthinteger,null<int32>nullable

    Publication month (1-12)

    Example: 2
    originalTitlestring | nullnullable

    Original title (for translated works)

    Example: 火星の人
    originalYearinteger,null<int32>nullable

    Original publication year (for re-releases or translations)

    Example: 2011
    pencillerstring | nullnullable

    Penciller(s) - comma-separated if multiple

    Example: David Mazzucchelli
    publisherstring | nullnullable

    Publisher name

    Example: DC Comics
    seriesPositionnumber,null<double>nullable

    Position in a series (e.g., 1.0, 2.5 for .5 volumes)

    Example: 1
    seriesTotalinteger,null<int32>nullable

    Total number of books in the series

    Example: 3
    subjectsstring[]nullable

    Subject/topic tags

    subtitlestring | nullnullable

    Book subtitle

    Example: A Novel
    summarystring | nullnullable

    Book summary/description

    Example: Bruce Wayne returns to Gotham City.
    translatorstring | nullnullable

    Translator name

    Example: John Smith
    volumeinteger,null<int32>nullable

    Volume number

    Example: 1
    writerstring | nullnullable

    Writer(s) - comma-separated if multiple

    Example: Frank Miller
    yearinteger,null<int32>nullable

    Publication year

    Example: 1987
    PatchBookMetadataRequest
    {
    "authors": "Unknown Type: array,null",
    "awards": "Unknown Type: array,null",
    "blackAndWhite": false,
    "bookType": "null",
    "colorist": "Richmond Lewis",
    "count": 4,
    "coverArtist": "David Mazzucchelli",
    "customMetadata": "Unknown Type: object,null",
    "day": 1,
    "edition": "First Edition",
    "editor": "Dennis O'Neil",
    "formatDetail": "Trade Paperback",
    "genre": "Superhero",
    "imprint": "DC Black Label",
    "inker": "David Mazzucchelli",
    "isbns": "978-1401207526",
    "languageIso": "en",
    "letterer": "Todd Klein",
    "manga": false,
    "month": 2,
    "originalTitle": "火星の人",
    "originalYear": 2011,
    "penciller": "David Mazzucchelli",
    "publisher": "DC Comics",
    "seriesPosition": 1,
    "seriesTotal": 3,
    "subjects": "Unknown Type: array,null",
    "subtitle": "A Novel",
    "summary": "Bruce Wayne returns to Gotham City.",
    "translator": "John Smith",
    "volume": 1,
    "writer": "Frank Miller",
    "year": 1987
    }