API Reference

Collections.updateCollectionInfo

Updates collection information such as title or description.


Syntax

bool collections.updateCollectionInfo ( int collection, string name = NULL, string description = NULL, int addToTop = NULL, int autoActive = NULL, string faceDetect = NULL )

Arguments

NameTypeRequiredDefault valueDescription
collectionintRequirednoneThe collection ID.
namestringOptionalNULLThe new collection name.
descriptionstringOptionalNULLThe new collection description.
addToTopintOptionalNULLWhether to add to top (0/1).
autoActiveintOptionalNULLAuto-active flag (0/1).
faceDetectstringOptionalNULLEnable face detection ("true"/"false").

Sample Response

Sample REST Response
http://api.newspark.ca/services/rest/collections/updateCollectionInfo?collection=[COLLECTION_ID]&name=[UPDATED_COLLECTION_NAME]&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 updateCollectionInfo.

Add a Comment

  • captcha