Delete a page

Contents

    Delete a page.

    All request to the API need the API Token, you can find the token in the settings of the plugin.

    All request to the API to write content is necessary to provide the Authorization Token. To get this token you need a user with Administrator role. Get the Authorization Token from the user profile.

    Request

    • Endpoint: /api/pages/<key>
    • Method: DELETE
    • Content-Type: application/json

    Bellow the list of parameters allowed for this endpoint.

    key value Default value
    required token string API Token.
    required authentication string Authentication token.

    Response

    • HTTP Code: 200
    • Content-Type: application/json
    • Content
    {
        "status": "0",
        "message": "Page deleted."
    }

    CURL command example

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

    $ curl  -X DELETE \
        --data "token=24a8857ed78a8c89a91c99afd503afa7" \
        --data "authentication=193569a9d341624e967486efb3d36d75" \
        -H "Content-Type: application/json" \
        "https://www.example.com/api/pages/my-dog"

    Output:

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