Collection.Add
  • 14 May 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Collection.Add

  • Dark
    Light
  • PDF

Article summary

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.

NameRequiredTypeDescription
NameTruestringThe name of the new collection.
DescriptionFalsestringA description for the new collection.

Responses

NameTypeDescription
ResultstringSuccess if the operation was successful.
CollectionIDnumericUnique 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
    }
  }
}

Was this article helpful?