Contents
On this page

Rate a Title - Plugixa Stream

PUT /plugixa-stream/v1/series/{id}/reviews/mine

Rate a title, with or without words. It replaces the caller’s earlier review of it.

Any signed-in user (an Application Password, or the login cookie with an X-WP-Nonce header). Signed out, it answers 401 plugixa_stream_login_required. It always acts on the caller’s own account. Rate-limited with the other review requests: 60 a minute per account.

Note. Stars alone are published at once. Words wait for the owner when the reviews_moderation setting is manual; unchanged words keep their approval when only the stars change. A review the owner hid stays hidden.

Request

PUT https://your-site.example/wp-json/plugixa-stream/v1/series/2681/reviews/mine

Path parameters

Name Type Description
id integer The title’s id

Request body

Content type: application/json

Field Type Required Description
rating integer Yes 1 to 5.
body string No Plain text, up to 2,000 characters. Dropped when written reviews are off.
spoiler boolean No Marks the words as a spoiler. Ignored without words.
{
  "rating": 5,
  "body": "Gorgeous, and the ending still gets me.",
  "spoiler": false
}

Responses

200 OK. data is the caller’s review.

{
  "success": true,
  "data": {
    "id": 31,
    "rating": 5,
    "body": "Gorgeous, and the ending still gets me.",
    "spoiler": false,
    "author": "Maya",
    "date": "2026-11-12T20:14:03+00:00",
    "edited": false,
    "mine": true,
    "status": "published"
  }
}
Field Type Meaning
data.id integer The review’s id
data.rating integer 1 to 5 stars
data.body string Plain text, empty for stars only
data.spoiler boolean The writer marked it as a spoiler
data.author string The profile name, else the first or display name. Never a login or an email
data.date string Written, ISO 8601 in UTC
data.edited boolean Changed since it was written
data.mine boolean Written by the caller’s profile
data.status string published; on the caller’s own review, also pending or hidden

Errors

Status Code When
401 plugixa_stream_login_required Signed out.
404 plugixa_stream_not_found No published title with that id, or a kids profile may not see it.
403 plugixa_stream_reviews_off Reviews are turned off.
403 plugixa_stream_reviews_kids The caller is on a kids profile.
403 plugixa_stream_reviews_watch_first The site asks viewers to watch a title before rating it, and the caller has no progress on it.
422 plugixa_stream_invalid rating is not 1 to 5, or body is too long.
429 plugixa_stream_rate_limited More than 60 requests of this kind in the current minute.

Plus the errors every endpoint can return.

Examples

curl -s -X PUT "https://your-site.example/wp-json/plugixa-stream/v1/series/2681/reviews/mine" \
  -u "$WP_USER:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"rating":5,"body":"Gorgeous, and the ending still gets me.","spoiler":false}'
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/series/2681/reviews/mine');
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([
        'rating'  => 5,
        'body'    => 'Gorgeous, and the ending still gets me.',
        'spoiler' => false,
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-stream/v1/series/2681/reviews/mine', {
  method: 'PUT',
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ rating: 5, body: 'Gorgeous, and the ending still gets me.', spoiler: false }),
});
const { data } = await response.json();

Quick Links

Share