API Reference

Collections.deleteCollection

Deletes a saved search or manual collection.


Syntax

bool collections.deleteCollection ( int id, int vhost = NULL )

Arguments

NameTypeRequiredDefault valueDescription
idintRequirednoneThe collection ID to delete.
vhostintOptionalNULLThe vhost ID (optional, defaults to parameter).

Sample Response

Sample REST Response
http://api.newspark.ca/services/rest/collections/deleteCollection?vhost=[VHOST_ID]&id=[COLLECTION_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 deleteCollection.

Add a Comment

  • captcha