This API v3 documentation is currently still on progress. For any issue, please contact support@runcloud.io

RunCloud

Update canvas

PUT

/settings/wordpress/canvas/{id}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

Example:

Header Params

string

optional

Example:

application/json

Content-Type

string

optional

Example:

application/json

Body Params application/json

name

string

required

selectedThemes

array [object {3}]

required

name

string

optional

slug

string

optional

activate

boolean

optional

selectedPlugins

array [object {3}]

required

name

string

required

slug

string

required

activate

boolean

required

customThemePlugin

array [object {4}]

required

label

string

required

link

string

required

type

string

required

activate

boolean

required

settings

object

required

removeHelloWorld

boolean

required

removeSamplePage

boolean

required

deleteAllThemes

boolean

required

deleteAllPlugins

boolean

required

deleteUnneededCoreFile

boolean

required

language

string

required

timezone

string

required

dateFormat

string

required

timeFormat

string

required

SEIndexingDisable

boolean

required

organizeUploadFolders

boolean

required

permalinkCustom

null

required

Example

{    "name": "Updated Canvas Name",
    "selectedThemes": [
        {
            "name": "Astra",
            "slug": "astra",
            "activate": true
        }
    ],
    "selectedPlugins": [
        {
            "name": "WordPress SEO",
            "slug": "wordpress-seo",
            "activate": true
        },
        {
            "name": "Elementor",
            "slug": "elementor",
            "activate": true
        }
    ],
 "customThemePlugin": [
	 {
		 "label": "some plugin",
		 "link": "https://example.com/plugin.zip",
		 "type": "custom-plugin",
		 "activate": true
	 },
	 {
		 "label": "some theme",
		 "link": "https://example.com/theme.zip",
		 "type": "custom-theme",
		 "activate": false
	 }
 ],
    "settings": {
        "removeHelloWorld": true,
        "removeSamplePage": true,
        "deleteAllThemes": false,
        "deleteAllPlugins": false,
        "deleteUnneededCoreFile": true,
        "language": "en_US",
        "timezone": "UTC",
			"dateFormat": "F j, Y",
			"timeFormat": "UTC",
"SEIndexingDisable": false,
			"organizeUploadFolders": true,
			"permalinkCustom": null
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://manage.runcloud.io/api/v3/settings/wordpress/canvas/45' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{    "name": "Updated Canvas Name",
    "selectedThemes": [
        {
            "name": "Astra",
            "slug": "astra",
            "activate": true
        }
    ],
    "selectedPlugins": [
        {
            "name": "WordPress SEO",
            "slug": "wordpress-seo",
            "activate": true
        },
        {
            "name": "Elementor",
            "slug": "elementor",
            "activate": true
        }
    ],
 "customThemePlugin": [
	 {
		 "label": "some plugin",
		 "link": "https://example.com/plugin.zip",
		 "type": "custom-plugin",
		 "activate": true
	 },
	 {
		 "label": "some theme",
		 "link": "https://example.com/theme.zip",
		 "type": "custom-theme",
		 "activate": false
	 }
 ],
    "settings": {
        "removeHelloWorld": true,
        "removeSamplePage": true,
        "deleteAllThemes": false,
        "deleteAllPlugins": false,
        "deleteUnneededCoreFile": true,
        "language": "en_US",
        "timezone": "UTC",
			"dateFormat": "F j, Y",
			"timeFormat": "UTC",
"SEIndexingDisable": false,
			"organizeUploadFolders": true,
			"permalinkCustom": null
    }
}'

Responses

🟢200Success

application/json

Body

integer

required

name

string

required

created_at

string

required

updated_at

string

required

themes

object

required

data

array [object {4}]

required

plugins

object

required

data

array [object {4}]

required

customThemes

object

required

data

array [object {4}]

required

customPlugins

object

required

data

array [object {4}]

required

settings

object

required

integer

required

language

string

required

timezone

string

required

dateFormat

string

required

timeFormat

string

required

SEIndexingDisable

boolean

required

organizeUploadFolders

boolean

required

permalinkCustom

null

required

removeHelloWorld

boolean

required

deleteAllThemes

boolean

required

deleteAllPlugins

boolean

required

deleteUnneededCoreFile

boolean

required

removeSamplePage

boolean

required

created_at

string

required

updated_at

string

required

Example

{"id":45,"name":"Updated Canvas Name","created_at":"2025-06-30T03:17:34.000000Z","updated_at":"2025-06-30T03:19:26.000000Z","themes":{"data":[{"id":125,"name":"Astra","activate":true,"slug":"astra"}]},"plugins":{"data":[{"id":126,"name":"WordPress SEO","activate":true,"slug":"wordpress-seo"},{"id":129,"name":"Elementor","activate":true,"slug":"elementor"}]},"customThemes":{"data":[{"id":131,"name":"some theme","activate":false,"link":"https:\/\/example.com\/theme.zip"}]},"customPlugins":{"data":[{"id":130,"name":"some plugin","activate":true,"link":"https:\/\/example.com\/plugin.zip"}]},"settings":{"id":39,"language":"en_US","timezone":"UTC","dateFormat":"F j, Y","timeFormat":"UTC","SEIndexingDisable":false,"organizeUploadFolders":true,"permalinkCustom":null,"removeHelloWorld":true,"deleteAllThemes":false,"deleteAllPlugins":false,"deleteUnneededCoreFile":true,"removeSamplePage":true,"created_at":"2025-06-30T03:17:34.000000Z","updated_at":"2025-06-30T03:17:34.000000Z"}}

Modified at 2025-07-08 05:55:01

Get canvas

Delete canvas