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

Collection.Delete

  • Dark
    Light
  • PDF

Article Summary

Description

Deletes the collection and all data within it.

WARNING!

This operation is permanent!

URL parameters

NameRequiredTypeDescription
CollectionIDTruenumericUnique identifier of the collection.

Responses

NameTypeDescription
ResultstringSuccess if the operation was successful.

Sample Request

curl -X GET 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Collection.Delete&CollectionID=1001'

Sample responses

XML

<?xml version="1.0" encoding="utf-8" ?>
<CollectionDeleteResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result>
</CollectionDeleteResponse>

JSON (add &ResponseFormat=JSON)

{
  "JsonResult": {
    "Command": "Collection.Delete",
    "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?