ChangePage

This function replaces an existing page with the new page content that you supply. The function will fail if the page does not yet exist (in which case you should call NewPage), if the page is locked for editing by a human , or if the page is locked by administrators.

Future versions of this function will permit the caller to override these (with administrative privileges) specify if the page should be admin-locked or hidden, etc.

Request Parameters

page Required
Specifies what page you'd like to change. If this page does not already exist, the function will fail. Since it is a GET parameter, it must be URI encoded.

email
Specifies the email address that this page edit should be attributed to. If using the Javascript API, this parameter is ignored and the user's logged-in email address is used instead.

name
Specifies the name that this page edit should be attributed to. If using the Javascript API, this parameter is ignored and the user's logged-in name is used instead.

locked optional (0 or 1)
Whether or not the new page should be locked for edits. Only honored if the current user is a moderator or admin. Pages are not locked by default.

hidden optional (0 or 1)
Whether or not the new page should be hidden from non-admins. Only honored if the current user is a moderator or admin. Pages are not hidden by default.

ip optional
The IP of the user responsible for this change. Note that the IP of the computer that made the API call is also separately logged in addition to being the default for this value.

note optional
A note you'd like to privately attach to the page, such as for use in your script during a subsequent GetPage.

POST data Required
The entire content of the POSTed data will be treated as the new page content. This data is not assumed to be escaped in any way and may contain Unicode. If the posted data is more than 100KB, the request will fail. For debugging purposes, you may provide a "data" parameter in the GET query string - this will override the POST body if given. This is not recommended for production use, however, as GET string length is quite limited.

Responses

The response will indicate the success or failure of the page edit; if successful, the URL of the page is returned.

Example

REQUEST

RESPONSE

{ "v1": {
  "pageURL": "http://YOURWIKI.pbwiki.com/SomeNewPage"
}}

 Create your own business wiki!Support CommunityPublic, Platinum wiki Privacy Policy RSS