Update series metadata

Required role: ADMIN

PATCH /api/v1/series/{seriesId}/metadata

Update series metadata

cURL

curl --request PATCH \
  --url https://demo.komga.org/api/v1/series/{seriesId}/metadata \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ageRating": 123,
  "ageRatingLock": true,
  "alternateTitles": [
    {
      "label": "<string>",
      "title": "<string>"
    }
  ],
  "alternateTitlesLock": true,
  "genres": [
    "<string>"
  ],
  "genresLock": true,
  "language": "<string>",
  "languageLock": true,
  "links": [
    {
      "label": "<string>",
      "url": "<string>"
    }
  ],
  "linksLock": true,
  "publisher": "<string>",
  "publisherLock": true,
  "readingDirection": "LEFT_TO_RIGHT",
  "readingDirectionLock": true,
  "sharingLabels": [
    "<string>"
  ],
  "sharingLabelsLock": true,
  "status": "ENDED",
  "statusLock": true,
  "summary": "<string>",
  "summaryLock": true,
  "tags": [
    "<string>"
  ],
  "tagsLock": true,
  "title": "<string>",
  "titleLock": true,
  "titleSort": "<string>",
  "titleSortLock": true,
  "totalBookCount": 123,
  "totalBookCountLock": true
}
'

400

{
  "violations": [
    {
      "fieldName": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

basicAuthapiKey

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

seriesId · string · required

Body

application/json

Metadata fields to update. Set a field to null to unset the metadata. You can omit fields you don't want to update.

ageRating · integer<int32>

ageRatingLock · boolean

alternateTitles · object[]

Show child attributes

alternateTitlesLock · boolean

genres · string[]

genresLock · boolean

language · string

languageLock · boolean

links · object[]

Show child attributes

linksLock · boolean

publisher · string

publisherLock · boolean

readingDirection · enum<string>

Available options: LEFT_TO_RIGHT, RIGHT_TO_LEFT, VERTICAL, WEBTOON

readingDirectionLock · boolean

sharingLabels · string[]

sharingLabelsLock · boolean

status · enum<string>

Available options: ENDED, ONGOING, ABANDONED, HIATUS

statusLock · boolean

summary · string

summaryLock · boolean

tags · string[]

tagsLock · boolean

title · string

titleLock · boolean

titleSort · string

titleSortLock · boolean

totalBookCount · integer<int32>

totalBookCountLock · boolean

Response

204

No Content