ReplaceSeriesMetadataRequest

PUT request for full replacement of series metadata

All metadata fields will be replaced with the values in this request. Omitting a field (or setting it to null) will clear that field.

ageRatinginteger,null<int32>nullable

Age rating (e.g., 13, 16, 18)

Example: 16

authors object[]

Structured author information

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

]

customMetadataobject | nullnullable

Custom JSON metadata for extensions

imprintstring | nullnullable

Imprint (sub-publisher)

Example: Vertigo

languagestring | nullnullable

Language (BCP47 format: "en", "ja", "ko")

Example: en

publisherstring | nullnullable

Publisher name

Example: DC Comics

readingDirectionstring | nullnullable

Reading direction (ltr, rtl, ttb or webtoon)

Example: ltr

statusstring | nullnullable

Series status (ongoing, ended, hiatus, abandoned, unknown)

Example: ended

summarystring | nullnullable

Series description/summary

Example: The definitive origin story of Batman.

titlestring | nullnullable

Series title/name

Example: Batman: Year One

titleSortstring | nullnullable

Custom sort name for ordering (e.g., "Batman Year One" instead of "The Batman Year One")

Example: Batman Year One

totalBookCountinteger,null<int32>nullable

Expected total book count (for ongoing series)

Example: 4

yearinteger,null<int32>nullable

Release year

Example: 1987

ReplaceSeriesMetadataRequest

{
  "ageRating": 16,
  "authors": "Unknown Type: array,null",
  "customMetadata": "Unknown Type: object,null",
  "imprint": "Vertigo",
  "language": "en",
  "publisher": "DC Comics",
  "readingDirection": "ltr",
  "status": "ended",
  "summary": "The definitive origin story of Batman.",
  "title": "Batman: Year One",
  "titleSort": "Batman Year One",
  "totalBookCount": 4,
  "year": 1987
}