API Reference

Channels.deleteChannel

Use this method to delete a channel from your vhost.


Syntax

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

Arguments

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>

Sample Response

Sample REST Response
http://api.newspark.ca/services/rest/channels/deleteChannel?id=[CHANNEL_ID]&APIKEY=[APIKEY]
<?xml version="1.0" encoding="UTF-8"?>
<result>1</result>
Sample JSON Response
{
    "status": true,
    "result": 1
}

Code examples

0 comments

Be the first to comment on deleteChannel.

Add a Comment

  • captcha