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
action=edit
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- Licence: GPL-2.0-or-later
Create and edit pages.
- title
- Title of the page to edit. Cannot be used together with pageid. 
- pageid
- Page ID of the page to edit. Cannot be used together with title. 
- Type: integer
- section
- Section identifier. 0 for the top section, new for a new section. Often a positive integer, but can also be non-numeric. 
- sectiontitle
- The title for a new section when using section=new. 
- text
- Page content. 
- summary
- Edit summary. - When this parameter is not provided or empty, an edit summary may be generated automatically. - When using section=new and sectiontitle is not provided, the value of this parameter is used for the section title instead, and an edit summary is generated automatically. 
- Change tags to apply to the revision. 
- Values (separate with | or alternative):
- minor
- Mark this edit as a minor edit. 
- Type: boolean (details)
- notminor
- Do not mark this edit as a minor edit even if the "Mark all edits as minor by default" user preference is set. 
- Type: boolean (details)
- bot
- Mark this edit as a bot edit. 
- Type: boolean (details)
- baserevid
- ID of the base revision, used to detect edit conflicts. May be obtained through action=query&prop=revisions. Self-conflicts cause the edit to fail unless basetimestamp is set. 
- Type: integer
- basetimestamp
- Timestamp of the base revision, used to detect edit conflicts. May be obtained through action=query&prop=revisions&rvprop=timestamp. Self-conflicts are ignored. 
- Type: timestamp (allowed formats)
- starttimestamp
- Timestamp when the editing process began, used to detect edit conflicts. An appropriate value may be obtained using curtimestamp when beginning the edit process (e.g. when loading the page content to edit). 
- Type: timestamp (allowed formats)
- recreate
- Override any errors about the page having been deleted in the meantime. 
- Type: boolean (details)
- createonly
- Don't edit the page if it exists already. 
- Type: boolean (details)
- nocreate
- Throw an error if the page doesn't exist. 
- Type: boolean (details)
- watch
- Deprecated.
- Add the page to the current user's watchlist. 
- Type: boolean (details)
- unwatch
- Deprecated.
- Remove the page from the current user's watchlist. 
- Type: boolean (details)
- watchlist
- Unconditionally add or remove the page from the current user's watchlist, use preferences (ignored for bot users) or do not change watch. 
- One of the following values: nochange, preferences, unwatch, watch
- Default: preferences
- md5
- The MD5 hash of the text parameter, or the prependtext and appendtext parameters concatenated. If set, the edit won't be done unless the hash is correct. 
- prependtext
- Add this text to the beginning of the page or section. Overrides text. 
- appendtext
- Add this text to the end of the page or section. Overrides text. - Use section=new to append a new section, rather than this parameter. 
- undo
- Undo this revision. Overrides text, prependtext and appendtext. 
- Type: integer
- The value must be no less than 0.
- undoafter
- Undo all revisions from undo to this one. If not set, just undo one revision. 
- Type: integer
- The value must be no less than 0.
- redirect
- Automatically resolve redirects. 
- Type: boolean (details)
- contentformat
- Content serialisation format used for the input text. 
- One of the following values: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
- contentmodel
- Content model of the new content. 
- One of the following values: GadgetDefinition, Scribunto, css, javascript, json, text, unknown, wikitext
- returnto
- Page title. If saving the edit created a temporary account, the API may respond with an URL that the client should visit to complete logging in. If this parameter is provided, the URL will redirect to the given page, instead of the page that was edited. 
- Type: page title
- Accepts non-existent pages.
- returntoquery
- URL query parameters (with leading ?). If saving the edit created a temporary account, the API may respond with an URL that the client should visit to complete logging in. If this parameter is provided, the URL will redirect to a page with the given query parameters. 
- Default: (empty)
- returntoanchor
- URL fragment (with leading #). If saving the edit created a temporary account, the API may respond with an URL that the client should visit to complete logging in. If this parameter is provided, the URL will redirect to a page with the given fragment. 
- Default: (empty)
- token
- A "csrf" token retrieved from action=query&meta=tokens - The token should always be sent as the last parameter, or at least after the text parameter. 
- This parameter is required.
- captchaword
- Answer to the CAPTCHA 
- captchaid
- CAPTCHA ID from previous request 
- Edit a page.
- api.php?action=edit&title=Test&summary=test%20summary&text=article%20content&baserevid=1234567&token=123ABC [open in sandbox]
- Prepend __NOTOC__ to a page.
- api.php?action=edit&title=Test&summary=NOTOC&minor=&prependtext=__NOTOC__%0A&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [open in sandbox]
- Undo revisions 13579 through 13585 with autosummary.
- api.php?action=edit&title=Test&undo=13585&undoafter=13579&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [open in sandbox]