Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-173438118.7 KB
Series

Update a series

Errors

Returns error if series not found, access denied, slug conflict, or database update error

put/api/series/{series_id}

Path parameters

series_idstring uuid required

UUID of the series to update

Request body

categorystring nullable

Updated category or genre of the series (optional)

coverImageUrlstring nullable

Update the series banner image with a new URL

descriptionstring nullable

Updated description of the series (optional)

slugstring nullable

New URL-friendly slug for the series (optional)

titlestring nullable

New title for the series (optional)

Example request

{
  "category": "Technology",
  "coverImageUrl": "https://example.com/new-cover.jpg",
  "description": "An updated description with more details",
  "slug": "my-updated-podcast",
  "title": "My Updated Podcast"
}

Response

Series updated successfully

categorystring nullable

Category or genre of the series

coverImageUrlstring nullable

URL to the series cover image

createdAtstring date-time nullable

Series creation timestamp

descriptionstring nullable

Description of the series content and purpose

idstring uuid required

Series unique identifier

lengthinteger nullable

Total number of posts in the series

slugstring required

SEO-friendly URL identifier for the series

titlestring required

Display name of the series

updatedAtstring date-time nullable

Series last update timestamp

userIdstring uuid required

ID of the user who owns this series

Example response

{
  "category": "Technology",
  "coverImageUrl": "https://example.com/cover.jpg",
  "createdAt": "2023-01-01T00:00:00Z",
  "description": "A weekly podcast about technology and innovation",
  "id": "e5f6a7b8-9012-3456-ef01-345678901234",
  "length": 42,
  "slug": "my-awesome-podcast",
  "title": "My Awesome Podcast",
  "updatedAt": "2023-01-01T12:00:00Z",
  "userId": "f6a7b8c9-0123-4567-f012-456789012345"
}