Contents
On this page

Update Series - Plugixa Stream

PUT /plugixa-stream/v1/admin/series/{id}

Change a title. Fields you leave out keep their value; a list field you send replaces the whole list. PATCH works the same way.

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/series/2681

Path parameters

Name Type Description
id integer The title’s id

Request body

Content type: application/json

Field Type Required Description
title string No Must not be blank.
synopsis string No HTML; tags WordPress does not allow in posts are removed.
status string No draft (the default) or publish. Anything else reads as draft.
kind string No series (the default) or movie. A title with more than one episode cannot become a movie.
release_year integer No 1900 to next year; anything else clears it.
poster_id integer No A Media Library image id, 0 for none. Also set as the featured image.
banner_id integer No A Media Library image id, 0 for none.
trailer_url string No A link to the trailer.
age_rating string No Empty, all, 7+, 13+, 16+ or 18+. Anything else clears it.
release_status string No ongoing (the default) or completed.
featured boolean No Show it in the home hero carousel.
free_count integer|null No Free episodes at the start, 0 to 1000. null or empty follows the site’s Free episodes per series setting.
original_lang string No The spoken language, a tag such as en or pt-BR.
genres integer[] No Term ids. Replaces the title’s genres. Also tags, studios and languages.
{
  "status": "publish",
  "featured": true,
  "free_count": 3
}

Responses

200 OK. data is the title as stored.

{
  "success": true,
  "data": {
    "id": 2681,
    "title": "Sintel",
    "slug": "sintel",
    "synopsis": "A lonely young woman, Sintel, helps and befriends a dragon, whom she calls Scales.",
    "status": "publish",
    "url": "https://your-site.example/series/sintel/",
    "modified_at": "2026-10-30 14:12:05",
    "episode_count": 1,
    "kind": "movie",
    "release_year": 2010,
    "poster_id": 2682,
    "banner_id": 2683,
    "trailer_url": "",
    "age_rating": "13+",
    "release_status": "completed",
    "featured": true,
    "free_count": 3,
    "original_lang": "en",
    "poster_url": "https://your-site.example/wp-content/uploads/2026/10/sintel-poster-219x300.jpg",
    "banner_url": "https://your-site.example/wp-content/uploads/2026/10/sintel-banner-1024x576.jpg",
    "genres": [39, 35, 6, 36],
    "tags": [],
    "studios": [57],
    "languages": [58]
  }
}
Field Type Meaning
data.id integer The title’s id
data.title string Raw title
data.slug string URL slug
data.synopsis string As stored: HTML without automatic paragraphs
data.status string publish or draft
data.url string Public page
data.modified_at string Last change, site time, Y-m-d H:i:s
data.episode_count integer Published, draft and scheduled episodes
data.kind string series or movie
data.release_year integer|null Release year
data.poster_id integer Media Library id, 0 for none
data.banner_id integer Media Library id, 0 for none
data.trailer_url string Trailer link
data.age_rating string Empty, all, 7+, 13+, 16+ or 18+
data.release_status string ongoing or completed
data.featured boolean In the home hero carousel
data.free_count integer|null Free episodes at the start; null follows the site default
data.original_lang string Spoken language tag
data.poster_url string Poster, medium size
data.banner_url string Banner, large size
data.genres integer[] Genre ids. Also tags, studios and languages

Errors

Status Code When
401 / 403 plugixa_stream_forbidden The caller lacks the capability.
404 plugixa_stream_not_found No title with that id.
422 plugixa_stream_invalid title is blank, or kind is movie on a title with more than one episode. data.field names the field.

Plus the errors every endpoint can return.

Examples

curl -s -X PUT "https://your-site.example/wp-json/plugixa-stream/v1/admin/series/2681" \
  -u "$WP_USER:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"status":"publish","featured":true,"free_count":3}'
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/admin/series/2681');
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'     => 'publish',
        'featured'   => true,
        'free_count' => 3,
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-stream/v1/admin/series/2681', {
  method: 'PUT',
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ status: 'publish', featured: true, free_count: 3 }),
});
const { data } = await response.json();

Quick Links

Share