Contents
On this page
Moderate Review - Plugixa Stream
PUT /plugixa-stream/v1/admin/reviews/{id}
Publish or hide a review. Publishing also clears its reports.
Needs a user with the plugixa_stream_edit capability (signed in with an Application Password or the login cookie). Administrators hold it; other roles only when you grant it.
Request
PUT https://your-site.example/wp-json/plugixa-stream/v1/admin/reviews/31
Path parameters
| Name | Type | Description |
|---|---|---|
id |
integer |
The review’s id |
Request body
Content type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
status |
string |
Yes | published or hidden. |
{
"status": "published"
}
Responses
200 OK.
{
"success": true,
"data": {
"pending": 0
}
}
| Field | Type | Meaning |
|---|---|---|
data.pending |
integer |
Reviews still waiting |
Errors
| Status | Code | When |
|---|---|---|
401 / 403 |
plugixa_stream_forbidden |
The caller lacks the capability. |
404 |
plugixa_stream_not_found |
No review with that id. |
422 |
plugixa_stream_invalid |
status is not published or hidden. |
Plus the errors every endpoint can return.
Examples
curl -s -X PUT "https://your-site.example/wp-json/plugixa-stream/v1/admin/reviews/31" \
-u "$WP_USER:$WP_APP_PASSWORD" \
-H "Content-Type: application/json" \
-d '{"status":"published"}'
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/admin/reviews/31');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERPWD => getenv('WP_USER') . ':' . getenv('WP_APP_PASSWORD'),
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode([
'status' => 'published',
]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-stream/v1/admin/reviews/31', {
method: 'PUT',
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ status: 'published' }),
});
const { data } = await response.json();
Quick Links
Share