Collection.Add

  • Updated on May 14, 2024
  • Published on May 25, 2021
  • 1 minute(s) read
  • vL
 Prev Next

Description

Adds an empty collection to your account.

URL parameters

URL parameter ordering

The URL parameters below are listed in the order they should be entered in the API URL.

Name Required Type Description
Name True string The name of the new collection.
Description False string A description for the new collection.

Responses

Name Type Description
Result string Success if the operation was successful.
CollectionID numeric Unique identifier for the new collection.

Sample request

curl -X GET 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Collection.Add&Name=MyFirstCollection&Description=My%20description'

Sample responses

XML

<?xmlversion="1.0"encoding="utf-8"?>
<CollectionAddResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result>
	<CollectionID>2259</CollectionID>
</CollectionAddResponse>

JSON (add &ResponseFormat=JSON)

{
  "CollectionID": 5414,
  "JsonResult": {
    "Command": "Collection.Add",
    "AutoLoggedIn": false,
    "WebConsoleKey": "",
    "Result": "Success",
    "ErrorCode": "",
    "ErrorDescription": "",
    "ErrorList": [],
    "ExecutionTime": {
      "Ticks": 0,
      "Days": 0,
      "Hours": 0,
      "Milliseconds": 0,
      "Minutes": 0,
      "Seconds": 0,
      "TotalDays": 0,
      "TotalHours": 0,
      "TotalMilliseconds": 0,
      "TotalMinutes": 0,
      "TotalSeconds": 0
    }
  }
}