Sign in

v1

latestOpenAPI 3.1.12026-07-2410095.4 KB
Channels

Create Channel

Creates a channel.

post/channels

Headers

X-Wistia-API-Versionstring required

Request body

namestring nullable

The display name for the channel

descriptionstring nullable

The channel's description.

auto_publish_enabledboolean

Whether the episodes are automatically published when added to the channel. Cannot be enabled if podcasting is on.

podcast_enabledboolean

Whether podcasting is enabled for this channel.

custom_urlstring nullable

Use if embedding the channel on your own site. The custom URL ensures links always direct to your page and not Wistia's.

Response

Channel created successful

idinteger required

The numeric id of the channel.

createdstring date-time required

The date when the channel was originally created.

descriptionstring required

The channel's description.

hashed_idstring required

A unique alphanumeric identifier for this channel.

media_countinteger required

The number of medias in the channel.

live_stream_event_countinteger

The number of live stream events in the channel.

namestring required

The display name for the channel

updatedstring date-time required

The date when the channel was last updated.

auto_publish_enabledboolean nullable

Whether episodes are automatically published when added to the channel.

podcast_enabledboolean nullable

Whether podcasting is enabled for the channel.

custom_urlstring nullable

The custom URL used when embedding the channel on your own site. Null if no custom URL is set.

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].