Description
Updates custom field information.
Request Parameters
- APIKey = {string} (required)
- The API key you are using to authenticate the access.
- Command = {CustomField.Update} (required)
- API Command
- ResponseFormat = {JSON | XML} (required)
- Response format
- JSONPCallBack = {bool}
- Send this parameter for cross-domain. More info about JSONP can be found here: http: //en.wikipedia.org/wiki/JSON#JSONP
- CustomFieldID = {integer} (required)
- ID of custom field to be updated
- FieldName = {string} (required)
- Name of new custom field
- FieldType = {Single line | Paragraph text | Multiple choice | Drop down | Checkboxes | Hidden field} (required)
- Type of new custom field
- FieldDefaultValue = {string} (required)
- Default value of new custom field
- OptionLabel[n] = {string} (required)
- label of nth option
- OptionValue[n] = {string} (required)
- value of nth option
- OptionSelected = {array} (required)
- array of selected option ids (Option ids are n)
- ValidationMethod = {Disabled | Numbers | Letters | Numbers and letters | Email address | URL | Date | Time | Custom} (required)
- Validation method of custom field
- ValidationRule = {string} (required)
- Validation rule of custom field
- Visibility = {Public | User Only}
- Whether to show custom field in subscriber area or not
- IsRequired = {Yes | No}
- Whether to make the custom field mandatory to fill in or not
- IsUnique = {Yes | No}
- Whether to force custom field entry to be unique or not
- IsGlobal = {Yes | No}
- If this parameter is set to 'Yes', custom field will be valid for all lists in the user account
Response Parameters
- Success = {true | false}
- States if there is an error or not
- ErrorCode = {integer}
- If there is an error, error's code
Error Codes
- 1
- Custom field id is missing
- 2
- Field name is missing
- 3
- Field type is missing
- 4
- Validation rule is missing
- 6
- Custom field id is invalid
- 7
- Field type is invalid
- 8
- Validation method is invalid
- 9
- Invalid visibility method
- 10
- Invalid IsRequired value
- 11
- Invalid IsUnique value
- 12
- Invalid IsGlobal value
- 99998
- Authentication failure or session expired
- 99999
- Not enough privileges