Sign in
Series

Create a new series

Errors

Returns error if series creation fails, slug conflict, or database error

post/api/series

Request body

categorystring nullable

Category or genre of the series (optional)

coverImageUrlstring nullable

Banner image URL for the series homepage

descriptionstring nullable

Description of the series content and purpose (optional)

slugstring required

Unique URL path segment for the new series

titlestring required

Name for the new series being created

Example request

{
  "category": "Technology",
  "coverImageUrl": "https://example.com/cover.jpg",
  "description": "A weekly podcast about technology and innovation",
  "slug": "my-awesome-podcast",
  "title": "My Awesome Podcast"
}

Response

Series created 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"
}

Changes

Changed in 5 of the 28 revisions of this API.434

  • 46cf137308831See the full diff
    • ○

      added the optional property length to the response with the 201 status

      response-optional-property-added

  • 6348840d4fcf33See the full diff
    • ▲

      removed the required property isMonetized from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property isPublished from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property pricingTier from the response with the 201 status

      response-required-property-removed

    • ●

      removed the request property isMonetized

      request-property-removed

    • ●

      removed the request property isPublished

      request-property-removed

    • ●

      removed the request property pricingTier

      request-property-removed

  • 143443c14b732See the full diff
    • ○

      the endpoint scheme security bearerAuth AND cookieAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security cookieAuth was removed from the API

      api-security-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 08a2378b4e661See the full diff
    • ○

      endpoint added

      endpoint-added

  • a2488be8a6e41See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog