update_list_entry
Modify details of a specific entry on the authorized user's AniList, including progress, scores, notes, and status, using the provided ID and updated options.
Instructions
[Requires Login] Update an entry on the authorized user's list
Input Schema
Name | Required | Description | Default |
---|---|---|---|
id | Yes | The AniList list ID of the entry to edit | |
options | Yes | Values to save with the entry |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "The AniList list ID of the entry to edit",
"type": "number"
},
"options": {
"additionalProperties": false,
"description": "Values to save with the entry",
"properties": {
"advancedScores": {
"description": "Advanced scores as an object",
"items": {
"type": "number"
},
"type": "array"
},
"completedAt": {
"additionalProperties": false,
"description": "When the user completed the media",
"properties": {
"day": {
"type": "number"
},
"month": {
"type": "number"
},
"year": {
"type": "number"
}
},
"required": [
"year",
"month",
"day"
],
"type": "object"
},
"customLists": {
"description": "Array of custom list names for the media",
"items": {
"type": "string"
},
"type": "array"
},
"hiddenFromStatusLists": {
"description": "Whether the entry should be hidden from non-custom lists",
"type": "boolean"
},
"id": {
"description": "The ID of the list entry",
"type": "number"
},
"mediaId": {
"description": "The ID of the media to add",
"type": "number"
},
"notes": {
"description": "Text notes about the media",
"type": "string"
},
"priority": {
"description": "Priority level of the media",
"type": "number"
},
"private": {
"description": "Whether the entry should be private",
"type": "boolean"
},
"progress": {
"description": "The amount of episodes/chapters consumed",
"type": "number"
},
"progressVolumes": {
"description": "The amount of volumes read (manga only)",
"type": "number"
},
"repeat": {
"description": "Amount of times the media has been repeated",
"type": "number"
},
"score": {
"description": "The score given to the media",
"type": "number"
},
"scoreRaw": {
"description": "The raw score in 100 point format",
"type": "number"
},
"startedAt": {
"additionalProperties": false,
"description": "When the user started the media",
"properties": {
"day": {
"type": "number"
},
"month": {
"type": "number"
},
"year": {
"type": "number"
}
},
"required": [
"year",
"month",
"day"
],
"type": "object"
},
"status": {
"description": "The status of the media on the list",
"enum": [
"CURRENT",
"PLANNING",
"COMPLETED",
"DROPPED",
"PAUSED",
"REPEATING"
],
"type": "string"
}
},
"required": [
"id",
"mediaId",
"status",
"score",
"scoreRaw",
"progress",
"progressVolumes",
"repeat",
"priority",
"private",
"notes",
"hiddenFromStatusLists",
"customLists",
"advancedScores",
"startedAt",
"completedAt"
],
"type": "object"
}
},
"required": [
"id",
"options"
],
"type": "object"
}