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=editsurvey

(main | editsurvey)
  • This module requires read rights.
  • This module only accepts POST requests.
  • Source: Survey
  • License: GPL-2.0-or-later

API module for editing a survey.

Specific parameters:
Other general parameters are available.
name

The name of the survey.

Default: (empty)
title

Title of the survey.

Default: (empty)
enabled

Enable the survey or not.

Type: integer
Default: 0
header

Text to display above the survey.

Default: Thank you for taking this short survey. Please fill out the following questions:
footer

Text to display below the survey.

Default: (empty)
thanks

Text to display after survey submission.

Default: Thank you for your responses.
user_type

Type of users that can participate in the survey.

Type: integer
Default: 0
namespaces

Namespaces on which the survey can be displayed.

Separate values with | or alternative.
Maximum number of values is 50 (500 for clients that are allowed higher limits).
Default: (empty)
ratio

Percentage of users to show the survey to.

Type: integer
Default: 100
expiry

Cookie expiry time for the survey.

Type: integer
Default: 2592000
min_pages

Min amount of pages the user needs to view before getting the survey.

Type: integer
Default: 0
id

The ID of the survey to modify.

This parameter is required.
Type: integer
questions

The questions that make up the survey.

This parameter is required.
Separate values with | or alternative.
Maximum number of values is 50 (500 for clients that are allowed higher limits).
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.