Skip to main content

MetadataLocks

Lock states for all lockable metadata fields

ageRatingbooleanrequired

Whether the age_rating field is locked

Example: false
customMetadatabooleanrequired

Whether the custom_metadata field is locked

Example: false
genresbooleanrequired

Whether the genres are locked

Example: false
imprintbooleanrequired

Whether the imprint field is locked

Example: false
languagebooleanrequired

Whether the language field is locked

Example: false
publisherbooleanrequired

Whether the publisher field is locked

Example: false
readingDirectionbooleanrequired

Whether the reading_direction field is locked

Example: false
statusbooleanrequired

Whether the status field is locked

Example: false
summarybooleanrequired

Whether the summary field is locked

Example: true
tagsbooleanrequired

Whether the tags are locked

Example: false
titlebooleanrequired

Whether the title field is locked

Example: false
titleSortbooleanrequired

Whether the title_sort field is locked

Example: false
totalBookCountbooleanrequired

Whether the total_book_count field is locked

Example: false
yearbooleanrequired

Whether the year field is locked

Example: false
MetadataLocks
{
"ageRating": false,
"customMetadata": false,
"genres": false,
"imprint": false,
"language": false,
"publisher": false,
"readingDirection": false,
"status": false,
"summary": true,
"tags": false,
"title": false,
"titleSort": false,
"totalBookCount": false,
"year": false
}