MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/API

action=wbsetdescription

(main | wbsetdescription)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: Wikibase Repository
License: GPL-2.0+

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.
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: aawiki, abwiki, acewiki, adywiki, afwiki, afwikiquote, akwiki, alswiki, alswikiquote, amwiki, amwikiquote, angwiki, angwikiquote, angwikisource, anwiki, arcwiki, arwiki, arwikinews, arwikiquote, arwikisource, arzwiki, astwiki, astwikiquote, aswiki, aswikisource, avwiki, aywiki, azbwiki, azwiki, azwikiquote, azwikisource, barwiki, bat_smgwiki, bawiki, bclwiki, be_x_oldwiki, bewiki, bewikiquote, bewikisource, bgwiki, bgwikinews, bgwikiquote, bgwikisource, bhwiki, biwiki, bjnwiki, bmwiki, bmwikiquote, bnwiki, bnwikisource, bowiki, bpywiki, brwiki, brwikiquote, brwikisource, bswiki, bswikinews, bswikiquote, bswikisource, bugwiki, bxrwiki, cawiki, cawikinews, cawikiquote, cawikisource, cbk_zamwiki, cdowiki, cebwiki, cewiki, chowiki, chrwiki, chwiki, chywiki, ckbwiki, commonswiki, cowiki, cowikiquote, crhwiki, crwiki, crwikiquote, csbwiki, cswiki, cswikinews, cswikiquote, cswikisource, cuwiki, cvwiki, cywiki, cywikiquote, cywikisource, dawiki, dawikiquote, dawikisource, dewiki, dewikinews, dewikiquote, dewikisource, dewikivoyage, diqwiki, dsbwiki, dvwiki, dzwiki, eewiki, elwiki, elwikinews, elwikiquote, elwikisource, elwikivoyage, emlwiki, enwiki, enwikinews, enwikiquote, enwikisource, enwikivoyage, eowiki, eowikinews, eowikiquote, eowikisource, eswiki, eswikinews, eswikiquote, eswikisource, eswikivoyage, etwiki, etwikiquote, etwikisource, euwiki, euwikiquote, extwiki, fawiki, fawikinews, fawikiquote, fawikisource, fawikivoyage, ffwiki, fiu_vrowiki, fiwiki, fiwikinews, fiwikiquote, fiwikisource, fjwiki, fowiki, fowikisource, frpwiki, frrwiki, frwiki, frwikinews, frwikiquote, frwikisource, frwikivoyage, furwiki, fywiki, gagwiki, ganwiki, gawiki, gawikiquote, gdwiki, glkwiki, glwiki, glwikiquote, glwikisource, gnwiki, gomwiki, gotwiki, guwiki, guwikiquote, guwikisource, gvwiki, hakwiki, hawiki, hawwiki, hewiki, hewikinews, hewikiquote, hewikisource, hewikivoyage, hifwiki, hiwiki, hiwikiquote, howiki, hrwiki, hrwikiquote, hrwikisource, hsbwiki, htwiki, htwikisource, huwiki, huwikinews, huwikiquote, huwikisource, hywiki, hywikiquote, hywikisource, hzwiki, iawiki, idwiki, idwikiquote, idwikisource, iewiki, igwiki, iiwiki, ikwiki, ilowiki, iowiki, iswiki, iswikiquote, iswikisource, itwiki, itwikinews, itwikiquote, itwikisource, itwikivoyage, iuwiki, jamwiki, jawiki, jawikinews, jawikiquote, jawikisource, jbowiki, jvwiki, kaawiki, kabwiki, kawiki, kawikiquote, kbdwiki, kgwiki, kiwiki, kjwiki, kkwiki, kkwikiquote, klwiki, kmwiki, knwiki, knwikiquote, knwikisource, koiwiki, kowiki, kowikinews, kowikiquote, kowikisource, krcwiki, krwiki, krwikiquote, kshwiki, kswiki, kswikiquote, kuwiki, kuwikiquote, kvwiki, kwwiki, kwwikiquote, kywiki, kywikiquote, ladwiki, lawiki, lawikiquote, lawikisource, lbewiki, lbwiki, lbwikiquote, lezwiki, lgwiki, lijwiki, liwiki, liwikiquote, liwikisource, lmowiki, lnwiki, lowiki, lrcwiki, ltgwiki, ltwiki, ltwikiquote, ltwikisource, lvwiki, maiwiki, map_bmswiki, mdfwiki, mgwiki, mhrwiki, mhwiki, minwiki, miwiki, mkwiki, mkwikisource, mlwiki, mlwikiquote, mlwikisource, mnwiki, mowiki, mrjwiki, mrwiki, mrwikiquote, mrwikisource, mswiki, mtwiki, muswiki, mwlwiki, myvwiki, mywiki, mznwiki, nahwiki, napwiki, nawiki, nawikiquote, nds_nlwiki, ndswiki, ndswikiquote, newiki, newwiki, ngwiki, nlwiki, nlwikinews, nlwikiquote, nlwikisource, nlwikivoyage, nnwiki, nnwikiquote, novwiki, nowiki, nowikinews, nowikiquote, nowikisource, nrmwiki, nsowiki, nvwiki, nywiki, ocwiki, omwiki, orwiki, orwikisource, oswiki, pagwiki, pamwiki, papwiki, pawiki, pcdwiki, pdcwiki, pflwiki, pihwiki, piwiki, plwiki, plwikinews, plwikiquote, plwikisource, plwikivoyage, pmswiki, pnbwiki, pntwiki, pswiki, ptwiki, ptwikinews, ptwikiquote, ptwikisource, ptwikivoyage, quwiki, quwikiquote, rmwiki, rmywiki, rnwiki, roa_rupwiki, roa_tarawiki, rowiki, rowikinews, rowikiquote, rowikisource, rowikivoyage, ruewiki, ruwiki, ruwikinews, ruwikiquote, ruwikisource, ruwikivoyage, rwwiki, sahwiki, sahwikisource, sawiki, sawikiquote, sawikisource, scnwiki, scowiki, scwiki, sdwiki, sdwikinews, sewiki, sgwiki, shwiki, simplewiki, simplewikiquote, siwiki, skwiki, skwikiquote, skwikisource, slwiki, slwikiquote, slwikisource, smwiki, snwiki, sowiki, sqwiki, sqwikinews, sqwikiquote, srnwiki, srwiki, srwikinews, srwikiquote, srwikisource, sswiki, stqwiki, stwiki, suwiki, suwikiquote, svwiki, svwikinews, svwikiquote, svwikisource, svwikivoyage, swwiki, szlwiki, tawiki, tawikinews, tawikiquote, tawikisource, tetwiki, tewiki, tewikiquote, tewikisource, tgwiki, thwiki, thwikinews, thwikiquote, thwikisource, tiwiki, tkwiki, tkwikiquote, tlwiki, tnwiki, towiki, tpiwiki, trwiki, trwikinews, trwikiquote, trwikisource, tswiki, ttwiki, ttwikiquote, tumwiki, twwiki, tyvwiki, tywiki, udmwiki, ugwiki, ugwikiquote, ukwiki, ukwikinews, ukwikiquote, ukwikisource, ukwikivoyage, urwiki, urwikiquote, uzwiki, uzwikiquote, vecwiki, vecwikisource, vepwiki, vewiki, viwiki, viwikiquote, viwikisource, viwikivoyage, vlswiki, vowiki, vowikiquote, warwiki, wawiki, wikidatawiki, wowiki, wowikiquote, wuuwiki, xalwiki, xhwiki, xmfwiki, yiwiki, yiwikisource, yowiki, zawiki, zawikiquote, zeawiki, zh_classicalwiki, zh_min_nanwiki, zh_min_nanwikiquote, zh_min_nanwikisource, zh_yuewiki, zhwiki, zhwikinews, zhwikiquote, zhwikisource, zhwikivoyage, zuwiki
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.
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 "bot".; Type: boolean (details)
language: Language of the description; This parameter is required.; One of the following values: aa, ab, ace, ady, ady-cyrl, aeb, aeb-arab, aeb-latn, af, ak, aln, als, am, an, ang, anp, ar, arc, arn, arq, ary, arz, as, ase, ast, av, avk, awa, ay, az, azb, ba, bar, bat-smg, bbc, bbc-latn, bcc, bcl, be, be-tarask, be-x-old, bg, bgn, bh, bho, bi, bjn, bm, bn, bo, bpy, bqi, br, brh, bs, bto, bug, bxr, ca, cbk-zam, cdo, ce, ceb, ch, cho, chr, chy, ckb, co, cps, cr, crh, crh-cyrl, crh-latn, cs, csb, cu, cv, cy, da, de, de-at, de-ch, de-formal, diq, dsb, dtp, dty, dv, dz, ee, egl, el, eml, en, en-ca, en-gb, eo, es, et, eu, ext, fa, ff, fi, fit, fiu-vro, fj, fo, fr, frc, frp, frr, fur, fy, ga, gag, gan, gan-hans, gan-hant, gd, gl, glk, gn, gom, gom-deva, gom-latn, got, grc, gsw, gu, gv, ha, hak, haw, he, hi, hif, hif-latn, hil, ho, hr, hrx, hsb, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, ike-cans, ike-latn, ilo, inh, io, is, it, iu, ja, jam, jbo, jut, jv, ka, kaa, kab, kbd, kbd-cyrl, kg, khw, ki, kiu, kj, kk, kk-arab, kk-cn, kk-cyrl, kk-kz, kk-latn, kk-tr, kl, km, kn, ko, ko-kp, koi, kr, krc, kri, krj, ks, ks-arab, ks-deva, ksh, ku, ku-arab, ku-latn, kv, kw, ky, la, lad, lb, lbe, lez, lfn, lg, li, lij, liv, lki, lmo, ln, lo, loz, lrc, lt, ltg, lus, luz, lv, lzh, lzz, mai, map-bms, mdf, mg, mh, mhr, mi, min, mk, ml, mn, mo, mr, mrj, ms, mt, mus, mwl, my, myv, mzn, na, nah, nan, nap, nb, nds, nds-nl, ne, new, ng, niu, nl, nl-informal, nn, no, nov, nrm, nso, nv, ny, oc, olo, om, or, os, pa, pag, pam, pap, pcd, pdc, pdt, pfl, pi, pih, pl, pms, pnb, pnt, prg, ps, pt, pt-br, qu, qug, rgn, rif, rm, rmy, rn, ro, roa-rup, roa-tara, ru, rue, rup, ruq, ruq-cyrl, ruq-latn, rw, sa, sah, sat, sc, scn, sco, sd, sdc, sdh, se, sei, ses, sg, sgs, sh, shi, shi-latn, shi-tfng, si, simple, sk, sl, sli, sm, sma, sn, so, sq, sr, sr-ec, sr-el, srn, ss, st, stq, su, sv, sw, szl, ta, tcy, te, tet, tg, tg-cyrl, tg-latn, th, ti, tk, tl, tly, tn, to, tokipona, tpi, tr, tru, ts, tt, tt-cyrl, tt-latn, tum, tw, ty, tyv, tzm, udm, ug, ug-arab, ug-latn, uk, ur, uz, uz-cyrl, uz-latn, ve, vec, vep, vi, vls, vmf, vo, vot, vro, wa, war, wo, wuu, xal, xh, xmf, yi, yo, yue, za, zea, 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 "Q42" as a description in English language: api.php?action=wbsetdescription&id=Q42&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]