channels.deleteChannel

Syntax

bool channels.deleteChannel ( int id, mixed recurse = 0 )

Argument Info

NameTypeRequiredDefault valueDescription
idintRequirednoneThe ID of the channel you want to delete.
recursemixedOptional0

Response

The response on successfully deleting a channel.

NameDescription
resultThe result will be 1 if the channel was deleted successfully. If there was an error the response will be <error><message>Channel with id: [CHANNELID] could not be found</message><type>Exception</type><code>0</code></error>

Return Values

FieldDescriptionPossible Values