hosting

PUT `/v1/sites/{siteId}/wordpress/users/{wpUserId}/role`

Change a WordPress account's role.

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione sites.view; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

Replaces the account's roles with exactly the one in the body — the other half of "add and remove administrators", and the half that lets a customer fix a mistake without deleting somebody's account and their authorship along with it. ⛔ **Replaces, never adds.** WordPress lets one account hold several roles at once, so granting the new role without removing the old one would leave a "demoted" administrator holding both — an account that reads as an editor on every screen and can still do everything. That outcome is indistinguishable from a successful demotion, which is why the distinction is stated here rather than left to the implementation. Its own path rather than a field on the user resource, for the same reason the password reset has one: a role change and a delete must not be two shapes of one request. **Promoting to `administrator` and demoting *from* one both** require the package's administrator-management capability, not merely `wp_users`. The promotion is obvious; the demotion matters just as much, because removing the last administrator's role locks every human out of the site as thoroughly as deleting them would. `422` for a role the install does not define, or a platform with no role field. `404` for a site with no vendor hosting package, and for an id that is not on it. Requires `sites.view` and `sites.panel_access`.

Parametri

Nome	Tipo	Obbligatorio	Che cos'è
`siteId (path)`	`Uuid`	Sì	Site ID (UUIDv7).
`wpUserId (path)`	`string`	Sì	The account's WordPress id, as `listSiteWordPressUsers` reports it.

Corpo della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`role`	`string`	Sì	The role the account should hold, from `listSiteWordPressRoles`.

Risposta

Nome	Tipo	Obbligatorio	Che cos'è
`id`	`string`	Sì	The account's WordPress id, carried as a string because it is the vendor's identifier rather than ours.
`login`	`string`	Sì	The name the account signs in with.
`display_name`	`string`	Sì	The name shown on the site's posts and comments.
`email`	`string`	Sì	The account's email address. Personal data about the customer's own users, which is why the whole listing is gated on `sites.panel_access`.
`roles`	`string`	Sì	The account's roles, in the vendor's own spelling.
`registered_at`	`string`	Sì	When WordPress recorded the account, in the vendor's own format. Not typed as a date-time: the platform does not guarantee one, and coercing it would invent precision.
`is_administrator`	`boolean`	Sì	Whether the account is an administrator. ⛔ Set from which vendor endpoint the row came from, not guessed from the role string — the two lists sit behind two different capabi…

Errori che questo endpoint può restituire

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

PUT /v1/sites/{siteId}/wordpress/users/{wpUserId}/role