API:Edit - Set user preferences

This page is part of the MediaWiki API documentation.

Language:	English

MediaWiki API

Quick overview:

• Quick start guide
• FAQ
  • Etiquette and usage limits
• Tutorial
• Formats
• Error reporting
• Restricting usage
• Cross-site requests
• Authentication
  • Login
  • Logout
  • Account creation
• Queries
  • Meta information
  • Properties
  • Lists
• Search suggestions
• Expanding templates and rendering
• Purging pages' caches
• Parameter information
• Changing wiki content
  • Create and edit pages
  • Move pages
  • Rollback
  • Delete pages
  • Restore deleted revisions
  • (Un)protect pages
  • (Un)block users
  • (Un)watch pages
  • Send email
  • Patrol changes
  • Import pages
  • Change user group membership
  • Upload files
  • User options
• Watchlist feed
• Wikidata
• Extensions
• Using the API in MediaWiki and extensions
• Miscellaneous
• Implementation
• Client code

SetUserPreferences

SetUserPreferences action allows to edit each user profile by passing any profile parameters which are desired to be changed such as name, email, newpassword. As shown in other features, sensible parameters must be passed by POST form.

Sample request and response:

Request:
  api.php ? action=setuserpreferences 

Post parameters:

  pruserid = 23            Obtained when the user has logged in.
  prusertoken = ber0cd5aa1bda4a5ve7lez230570b00na1a          Obtained when the user has been logged
  [ proldpassword = 123abc ]               Old password the user used to have  
  [ prnewpassword = 123abc ]               New password desired by the user  
  [ prretypepassword = 123abc ]            Retyping the new desired password is required  
  [ prname = "John" ]      User Name. It is not a mandatory field
  [ premail = john.smith@yahoo.com ]       User email address
  [ prnickname = "Johnny" ]                User signature
  [ ccmeonemail = yes/no ]                 To send me copies of emails sent to other users
  [ premailflag = yes/no ]                 Enable e-mail from other users
  

Response:
api:
   userpreferences:
              result: Success             Other values: UserIsAnon, WrongPassword, BadRetype, WrongEmailAddress

.