Description

This method adds a custom field to the list of custom field definitions.

Parameters

Name Values
name The name of the custom field to add. This must be a unique value and match ^[a-zA-Z0-9_]{1,128}$
dataType The data type of the new custom field. Valid values are:
  • datetime
  • bool
  • int
  • string

Sample Response

<?xml version="1.0" encoding="utf-8"?>
<result>
  <code><![CDATA[SUCCESS]]></ code>
  <message><![CDATA[Custom field was added.]]></message>
</result>

Return Codes

  • SUCCESS
  • ERROR
  • READONLY
  • CUSTOMFIELD_INVALID_FIELD_NAME
  • CUSTOMFIELD_INVALID_DATATYPE
  • CUSTOMFIELD_FIELD_NAME_IS_NOT_UNIQUE