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

(main | wbsetdescription)
  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: WikibaseClient
  • Licence: GPL-2.0-or-later

Sets a description for a single Wikibase entity.

Parameters:
id

The identifier for the entity, including the prefix. Use either id or site and title together.

new

If set, a new entity will be created. Set this to the type of the entity you want to create.

One of the following values: item, property
site

An identifier for the site on which the page resides. Use together with title to make a complete sitelink.

One of the following values:
title

Title of the page to associate. Use together with site to make a complete sitelink.

baserevid

The numeric identifier for the revision to base the modification on. This is used for detecting conflicts during save.

Type: integer
summary

Summary for the edit. Will be prepended by an automatically generated comment. The length limit of the autocomment together with the summary is 260 characters. Be aware that everything above that limit will be cut off.

tags

Change tags to apply to the revision.

Values (separate with | or alternative):
token

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

This parameter is required.
bot

Mark this edit as bot. This URL flag will only be respected if the user belongs to the group "Bots".

Type: boolean (details)
language

Language of the description

This parameter is required.
One of the following values: aa, ab, abs, ace, ady, ady-cyrl, aeb, aeb-arab, aeb-latn, af, agq, ak, aln, als, alt, am, ami, an, ang, anp, ar, arc, arn, arq, ary, arz, as, ase, ast, atj, av, avk, awa, ay, az, azb, ba, bag, ban, ban-bali, bar, bas, bat-smg, bax, bbc, bbc-latn, bbj, bcc, bci, bcl, be, be-tarask, be-x-old, bfd, bg, bgn, bh, bho, bi, bjn, bkc, bkh, bkm, blk, bm, bn, bo, bpy, bqi, bqz, br, brh, bs, btm, bto, bug, bxr, byv, ca, cak, cbk-zam, cdo, ce, ceb, ch, cho, chr, chy, ckb, cnh, co, cps, cr, crh, crh-cyrl, crh-latn, cs, csb, cu, cv, cy, da, dag, de, de-at, de-ch, de-formal, din, diq, dsb, dtp, dty, dua, dv, dz, ee, egl, el, eml, en, en-ca, en-gb, en-us, eo, es, es-419, es-formal, et, eto, etu, eu, ewo, ext, fa, fat, ff, fi, fit, fiu-vro, fj, fkv, fmp, fo, fon, fr, frc, frp, frr, fur, fy, ga, gaa, gag, gan, gan-hans, gan-hant, gcr, gd, gl, gld, glk, gn, gom, gom-deva, gom-latn, gor, got, gpe, grc, gsw, gu, guc, gur, guw, gv, gya, ha, hak, haw, he, hi, hif, hif-latn, hil, ho, hr, hrx, hsb, hsn, ht, hu, hu-formal, hy, hyw, hz, ia, id, ie, ig, ii, ik, ike-cans, ike-latn, ilo, inh, io, is, isu, it, iu, ja, jam, jbo, jut, jv, ka, kaa, kab, kbd, kbd-cyrl, kbp, kcg, kea, ker, kg, khw, ki, kiu, kj, kjp, kk, kk-arab, kk-cn, kk-cyrl, kk-kz, kk-latn, kk-tr, kl, km, kn, ko, ko-kp, koi, kr, krc, kri, krj, krl, ks, ks-arab, ks-deva, ksf, ksh, ksw, ku, ku-arab, ku-latn, kum, kv, kw, ky, la, lad, lb, lbe, lem, lez, lfn, lg, li, lij, liv, lki, lld, lmo, ln, lns, lo, loz, lrc, lt, ltg, lus, luz, lv, lzh, lzz, mad, mai, map-bms, mcn, mcp, mdf, mg, mh, mhr, mi, min, mk, ml, mn, mni, mnw, mo, mos, mr, mrh, mrj, ms, ms-arab, mt, mua, mus, mwl, my, myv, mzn, na, nah, nan, nan-hani, nap, nb, nds, nds-nl, ne, new, ng, nge, nia, niu, nl, nl-informal, nla, nmg, nmz, nn, nnh, nnz, no, nod, nov, nqo, nrm, nso, nv, ny, nyn, nys, oc, ojb, olo, om, or, os, osa-latn, ota, pa, pag, pam, pap, pap-aw, pcd, pcm, pdc, pdt, pfl, pi, pih, pl, pms, pnb, pnt, prg, ps, pt, pt-br, pwn, qu, quc, qug, rgn, rif, rm, rmc, rmf, rmy, rn, ro, roa-rup, roa-tara, rsk, ru, rue, rup, ruq, ruq-cyrl, ruq-latn, rw, rwr, ryu, sa, sah, sat, sc, scn, sco, sd, sdc, sdh, se, se-fi, se-no, se-se, sei, ses, sg, sgs, sh, shi, shi-latn, shi-tfng, shn, shy, shy-latn, si, simple, sjd, sje, sju, sk, skr, skr-arab, sl, sli, sm, sma, smj, smn, sms, sn, so, sq, sr, sr-ec, sr-el, srn, sro, srq, ss, st, stq, sty, su, sv, sw, syl, szl, szy, ta, tay, tcy, tdd, te, tet, tg, tg-cyrl, tg-latn, th, ti, tk, tl, tly, tly-cyrl, tn, to, tpi, tr, tru, trv, ts, tt, tt-cyrl, tt-latn, tum, tvu, tw, ty, tyv, tzm, udm, ug, ug-arab, ug-latn, uk, ur, uz, uz-cyrl, uz-latn, ve, vec, vep, vi, vls, vmf, vmw, vo, vot, vro, vut, wa, war, wes, wls, wo, wuu, wya, xal, xh, xmf, xsy, yas, yat, yav, ybb, yi, yo, yrl, yue, za, zea, zgh, zh, zh-classical, zh-cn, zh-hans, zh-hant, zh-hk, zh-min-nan, zh-mo, zh-my, zh-sg, zh-tw, zh-yue, zu
value

The value to set for the description

Examples:
Set the string "An encyclopedia that everyone can edit" for page with ID "Q999999998" as a description in English language
api.php?action=wbsetdescription&id=Q999999998&language=en&value=An%20encyclopedia%20that%20everyone%20can%20edit [open in sandbox]
Set the string "An encyclopedia that everyone can edit" as a description in English language for page with a sitelink to enwiki:Wikipedia
api.php?action=wbsetdescription&site=enwiki&title=Wikipedia&language=en&value=An%20encyclopedia%20that%20everyone%20can%20edit [open in sandbox]