latestSwagger 2.0Apache 2.02026-08-2034903.0 MB

3c5164c707eb

Wikis

Replace a Wiki

Renames the specified wiki page by setting its name attribute. This is the only attribute that can be changed through this endpoint; to update the content of a wiki page, create a new wiki version instead. Wiki pages can be updated with either a PUT or PATCH request. Unlike PATCH, a PUT request must include the name attribute in the request body.

The home wiki page cannot be renamed.

Permissions

Only contributors with write access to the parent node may rename a wiki page (or any user, if the node's wiki has been made publicly editable). Wiki pages on registrations cannot be renamed.

Returns

Returns a JSON object with a data key containing the new representation of the updated wiki, if the request is successful.

If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the list of error codes to understand why this request may have failed. Some common error cases:

  • 405 Method Not Allowed: Returned if write access to this wiki's node has been restricted. The response will include the message "This action is no longer available. Contact support if you have any questions."
put/wikis/{wiki_id}/

Path parameters

wiki_idstring required

The unique identifier of the wiki.

Request body

object required

Example request

{
  "data": {
    "type": "wikis",
    "id": "{wiki_id}",
    "attributes": {
      "name": "A new page name"
    }
  }
}

Response

OK