MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
command=update
(main | readinglists | update)
- This module is internal or unstable. Its operation may change without notice.
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: ReadingLists
- License: GPL-2.0-or-later
Update a list belonging to the current user.
Parameters:
- list
List ID. Required unless using batch update.
- Type: integer
- name
New list name. Either this or description is required unless doing batch update.
- Cannot be longer than 255 bytes.
- description
New list description.
- Cannot be longer than 767 bytes.
- batch
Batch data for updating multiple lists in a single request, in the form of a JSON array with one or more objects with list, name and description fields. Name and description are optional but at least one of them must be present.
Examples:
- Change the name of the reading list with ID 42.
- api.php?action=readinglists&command=update&list=42&name=New+name&token=123ABC [open in sandbox]
- Update multiple lists.
- api.php?action=readinglists&command=update&batch=%5B%7B%22list%22%3A42%2C%22name%22%3A%22New+name%22%7D%2C%7B%22list%22%3A43%2C%22description%22%3A%22New+description%22%7D%5D&token=123ABC [open in sandbox]