Skip to main content

BulkPatchSeriesMetadataRequest

Bulk PATCH request for series metadata

Applies the same partial update to all specified series. Only provided fields will be updated. Absent fields are unchanged. Explicitly null fields will be cleared. Title, title_sort, and summary are excluded (too unique per item). Max 100 series per request.

ageRatinginteger,null<int32>nullable

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

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 (uses RFC 7386 JSON Merge Patch semantics)

    imprintstring | nullnullable

    Imprint (sub-publisher)

    languagestring | nullnullable

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

    publisherstring | nullnullable

    Publisher name

    readingDirectionstring | nullnullable

    Reading direction (ltr, rtl, ttb or webtoon)

    seriesIdsstring<uuid>[]required

    Series IDs to update (max 100)

    statusstring | nullnullable

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

    totalBookCountinteger,null<int32>nullable

    Expected total book count (for ongoing series)

    yearinteger,null<int32>nullable

    Release year

    BulkPatchSeriesMetadataRequest
    {
      "ageRating": 0,
      "authors": "Unknown Type: array,null",
      "customMetadata": "Unknown Type: object,null",
      "imprint": "string",
      "language": "string",
      "publisher": "string",
      "readingDirection": "string",
      "seriesIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "status": "string",
      "totalBookCount": 0,
      "year": 0
    }