hosting

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

Change a WordPress account's role.

Autentikasi

Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin sites.view; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.

Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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> }'

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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`.

Parameter

Nama	Jenis	Wajib	Tentang apa ini
`siteId (path)`	`Uuid`	Ya	Site ID (UUIDv7).
`wpUserId (path)`	`string`	Ya	The account's WordPress id, as `listSiteWordPressUsers` reports it.

Isi permintaan

Nama	Jenis	Wajib	Tentang apa ini
`role`	`string`	Ya	The role the account should hold, from `listSiteWordPressRoles`.

Tanggapan

Nama	Jenis	Wajib	Tentang apa ini
`id`	`string`	Ya	The account's WordPress id, carried as a string because it is the vendor's identifier rather than ours.
`login`	`string`	Ya	The name the account signs in with.
`display_name`	`string`	Ya	The name shown on the site's posts and comments.
`email`	`string`	Ya	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`	Ya	The account's roles, in the vendor's own spelling.
`registered_at`	`string`	Ya	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`	Ya	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…

Kesalahan yang dapat dikembalikan oleh titik akhir ini

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

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