hosting

PUT `/v1/sites/{siteId}/wordpress/plugins/{pluginName}`

Activate or deactivate a plugin on a site.

Authentication

Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/wordpress/plugins/{pluginName} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "active": <boolean> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Sets whether the plugin is active, and returns the whole plugin listing so the card re-renders from the server's answer. The plugin is addressed by **path** rather than by a field in the body, so activate and delete cannot be confused for one another by a caller that got a body wrong. Deactivating a plugin can take a live site's checkout, cache or security layer with it. Refused `422` when the package type does not carry `wp_plugins`, or when WordPress is not installed. `404` for a site with no vendor hosting package. Requires `sites.view` and `sites.panel_access`.

Parameters

Name	Type	Required	What it is
`siteId (path)`	`Uuid`	Yes	Site ID (UUIDv7).
`pluginName (path)`	`string`	Yes	The plugin's slug, exactly as `listSiteWordPressPlugins` reports it. It is WordPress's identifier, not ours, so percent-encode it; a slug containing a slash does not route and a…

Request body

Name	Type	Required	What it is
`active`	`boolean`	Yes	Whether the plugin should be running after this call.

Response

Name	Type	Required	What it is
`data`	`SiteWordPressPlugin[]`	Yes	The installed plugins.
`stack_cache_installed`	`boolean`	Yes	⛔ Cannot be derived from `data`. this platform excludes its own server-side cache plugin from the listing, so a client deriving this flag from the rows would answer "not ins…

Errors this endpoint can return

401 · 403 · 404 · 409 · 422 · 429 · 503

PUT /v1/sites/{siteId}/wordpress/plugins/{pluginName}