collections.updateCollectionInfo
Syntax
bool collections.updateCollectionInfo (
int collection,
string name = NULL,
string description = NULL,
int addToTop = NULL,
int autoActive = NULL,
mixed faceDetect = NULL )
Argument Info
| Name | Type | Required | Default value | Description |
|---|
| collection | int | Required | none | The ID of the collection you are updating. |
| name | string | Optional | NULL | The new name of the collection. |
| description | string | Optional | NULL | The updated description of the collection. |
| addToTop | int | Optional | NULL | The updated addToTop value (0/1). |
| autoActive | int | Optional | NULL | The updated autoActive value (0/1). |
| faceDetect | mixed | Optional | NULL | |
Response
The response will be 1 if the collection has been updated successfully. An error message will be returned if there was an error with the request (ie. invalid collection ID).
| Name | Type | Description | Default Values |
|---|
| result | INT | Upon success the response will be a 1. | 1 = success, error message |
Return Values
| Field | Description | Possible Values |
|---|
