channels.newChannel

Syntax

int channels.newChannel ( int vhost, string name, string shortname, string description = '', int parentchannel = 0, array geoblocking = array(), string emailaddress = NULL, mixed visibility = 'SHOWN' )

Argument Info

NameTypeRequiredDefault valueDescription
vhostintRequirednoneThe vhost id.
namestringRequirednoneThe name of the channel.
shortnamestringRequirednoneShortname (for email and urls).
descriptionstringOptional''A description of the content that the channel was created to group together.
parentchannelintOptional0Id of the parent channel (0 for no parent).
geoblockingarrayOptionalarray()Each item is a country code that is allowed to view the media item, if empty then all countries may view the media (default: empty).
emailaddressstringOptionalNULLEmail address to be used for media intake through email. Leave empty to disable, must be unique.
visibilitymixedOptional'SHOWN'"SHOWN or "HIDDEN". Hiding a channel does not make the media within private, hidden or otherwise inaccessible.

Response

The response on successfully deleting a channel.

NameDescription
resultThe new channel ID that has just been created.

Return Values

FieldDescriptionPossible Values