WIwistia
Channel Episodes

Create Channel Episode

Changed on

Creates a new channel episode in a channel.

Requires api token with one of the following permissions

Read, update & delete anything

Tokens with the "Act with a team member's permissions" permission (all:delegate_to_contact_permissions scope) can also be used. Requests made with such a token are authorized using the permissions of the contact assigned to the token.

An expiring access token created with the all:delegate_to_contact_permissions scope and an authorization granting the update permission on this channel can also be used.

post/channels/{channelHashedId}/channel_episodes

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/channels/{channelHashedId}/channel_episodes
  • Auth
    HTTP bearer

Path parameters

channelHashedIdstring required

The hashed ID of the channel to add the episode to.

Headers

X-Wistia-API-Versionstring required

Request body

media_idstring

The alphanumeric hashed ID of the media to be added as a channel episode.

titlestring

The episode's title. If not provided, the channel episode uses the title of the media used to create it.

descriptionstring

The episode's description or episode notes.

summarystring

A short summary of the episode that is displayed when space is limited.

publish_status'draft' | 'published' | 'scheduled'

The status of whether or not the episode has been published to your channel.

publish_atstring date-time

The date and time when the episode should be published in UTC timezone. Required when publish_status is 'scheduled'. Must be a valid ISO8601 timestamp in UTC (ending with 'Z'). Can only be provided when publish_status is 'scheduled.'

Example request

{
  "title": "My New Episode",
  "description": "My Episode Description.",
  "summary": "A short description.",
  "publish_at": "2024-12-31T23:59:59Z"
}

Response

Channel Episode creation successful

idinteger

A unique numeric identifier for the channel episode.

channel_hashed_idstring required

A unique alphanumeric identifier for the channel episode's channel.

createdstring date-time required

The date when the channel episode was originally created.

cursorstring nullable

A cursor for stable pagination based on current sort_by order. You can pass this to cursor[before] or cursor[after] as a parameter to fetch the records before or after this record in the same sort order. This is only populated if records were fetched with cursor[enabled], or cursor[before] or cursor[after].

descriptionstring required

The channel episode's description or episode notes.

summarystring required

A short summary of the episode that is displayed when space is limited.

hashed_idstring required

A unique alphanumeric identifier for the channel episode.

media_hashed_idstring required

A unique alphanumeric identifier for the channel episode's media.

live_stream_event_hashed_idstring nullable

A unique alphanumeric identifier for the channel episode's live stream event, if any. Null when the episode is not linked to a live stream event.

publishedboolean required

Whether the channel episode has been published or is still in draft form.

publish_atstring date-time

The date and time when the episode is scheduled to be published in UTC timezone (only present when publish_status is 'scheduled').

titlestring nullable required

The title of the channel episode

updatedstring date-time required

The date when the channel was last updated.

Example response

{
  "summary": "A short description.",
  "publish_at": "2024-12-31T23:59:59Z"
}

Changes