Collection.DeleteField

Description

Deletes a field from the collection. This operation will not work on system collections or on Agent collections.

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
`CollectionID`	True	numeric	Unique identifier of the collection.
`Field`	True	string	The name of the field being deleted.

Responses

Name	Type	Description
`Result`	string	`Success` 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.DeleteField&CollectionID=1001&Field=ExampleFieldName'

Sample responses

XML

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

JSON (add `&ResponseFormat=JSON`)

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