hosting

PUT /v1/sites/{siteId}/wordpress/settings

Set one WordPress option on a site.

All hosting endpoints

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/settings \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "option": <string>, "value": <string> }'

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

Writes a single option and returns the whole option map. The option is named in the **body** rather than the path: unlike a plugin slug it is not a resource, and this platform writes one option per call, so one write endpoint is the honest shape. ⛔ An option the vendor does not publish is refused `422` rather than written blindly — writing an unknown key into a live WordPress is how a site gets a setting nothing can read back and nothing can undo. `404` for a site with no vendor hosting package. Requires `sites.view` and `sites.panel_access`.

Parameters

NameTypeRequiredWhat it is
siteId (path)UuidYesSite ID (UUIDv7).

Request body

NameTypeRequiredWhat it is
optionstringYesThe option name, as `getSiteWordPressSettings` reports it. An option the vendor does not publish is refused.
valuestringYesThe new value. May be empty — clearing a tagline is a legitimate edit, not a mistake to guess at.

Response

NameTypeRequiredWhat it is
dataobjectYesThe options, keyed by name.

Errors this endpoint can return

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