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

Collection.UpdateField

  • Dark
    Light
  • PDF

Article summary

Description

Modifies an existing field in a collection.

URL parameters

URL parameter ordering

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

NameRequiredTypeDescription
CollectionIDTruenumericUnique identifier of the collection.
FieldIDTruenumericUnique identifier of the field.
DescriptionFalsestringDescription of the field.
FormatFalsestringCurrently supported options are Text, File, and DateTime.
NameFalsestringName for the field.

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.UpdateField&CollectionID=1008&FieldID=1098&Name=MyNewFieldName&Description=My%20new%20field%20description&Format=File'

Sample Responses

XML

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

JSON

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