Edit a page

Edit a page.

All requests to the API need the API Token. You can find the token in the API plugin settings.

Admin panel > Plugins > API > API Token

For all requests to the API for write content, you'll need to provide the Authentication Token. To get this token, you need a user with Administrator role. Get the Authentication Token from the user profile.

Admin panel > Manage > Users > {Username} > Security > Authentication Token

HTTP Request

PUT /api/pages/{key}

Parameters

key	value	Default value
required token	string API Token.
required authentication	string Authentication token.
title	string Page title.
content	string Page content.
tags	string Page tags.
type	string Page type.
date	string Page date.
dateModified	string Page modified date.
position	string Page position.
coverImage	string Page cover image.
category	string Page category.
template	string Page template.
noindex	string Page noindex.
nofollow	string Page nofollow.
noarchive	string Page noarchive.

Response

HTTP Code: 200
Content-Type: application/json
Body:
{
    "status": "0",
    "message": "Page edited.",
    "data": {
        "key": "<page key>"
    }
}

CURL command example

The follow curl example shows how to edit a page with the key my-dog.

Content of file data.json

{
    "token": "24a8857ed78a8c89a91c99afd503afa7",
    "authentication": "193569a9d341624e967486efb3d36d75",
    "title": "My dog",
    "content": "Content of the page here, support Markdown code and HTML code."
}

Execute the command and attach the data.json file:

$ curl  -X PUT \
    -H "Content-Type: application/json" \
    -d @data.json \
    "https://www.example.com/api/pages/my-dog"

Response Body

{
    "status": "0",
    "message": "Page edited.",
    "data": {
        "key": "my-dog"
    }
}