Create Custom Object Field
Creates a new field for an existing custom object.
Endpoint
https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectFieldCommon Parameters
These parameters are used in all requests. Parameters specific to a field type will be shown in that field’s section on this page.
Parameters
| Parameter | Required | Description |
|---|---|---|
| objectApiName | Required | This is the token used to identify the Custom Object when accessing it from the API. |
| customObjectField.fieldLabel | Required | This is the unique name used to identify the field in the custom object. It will also be used in the data entry and data list pages. |
| customObjectField.fieldName | Required | This is the unique name used as the API base name. Spaces are not allowed. Be careful when renaming this field as it may break API code that references fields by this name. |
| customObjectField.fieldDataType | Required | Possible values: AUTO_NUMBER, TEXT, FORMULA, NUMBER, EMAIL, PHONE, URL, PERCENT, TEXTAREA_SHORT, TEXTAREA, DATE, DATETIME, CHECKBOX, CHECKBOX_SINGLE, DROPDOWN, RADIO, MASTER_DETAIL, LOOKUP, FILE_UPLOAD |
| customObjectField.fieldDescription | On the data entry screen, this message shows up as the header content of the popup window when you click the magnifying glass to search this field. | |
| customObjectField.fieldHelpText | This message shows up when you move the mouse over the corresponding question mark on the data entry form and listing page. | |
| customObjectField.isInternal | Possible values: TRUE, FALSE. Enable this if you want to make this field available only to system users and hide it from any public-facing web pages. |
Types of Fields
The following types of fields are available for creation:
- Auto-Number
- Formula
- Master / Detail
- Lookup
- Text
- Number
- Phone
- URL
- Percent
- Textarea – Short
- Textarea
- Date
- Date + Time
- Checkbox (single)
- Checkbox List
- Dropdown
- Radio
- File Upload
Auto-Number Fields
A field to store auto-incremented numbers. Prefixed text/code can be added to the number.
Request
https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectField.fieldLabel=Auto Number&customObjectField.fieldDescription=An auto-number field.&customObjectField.fieldHelpText=This field automatically increases.&customObjectField.fieldDataType=AUTO_NUMBER&customObjectField.isInternal=false&customObjectField.autoNumberFieldAttributes.startingNumber=52&customObjectField.autoNumberFieldAttributes.displayFormat=G{0000}&customObjectField.fieldName=Example Auto Number Field
Parameters
| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | AUTO_NUMBER |
| customObjectField.autoNumberFieldAttributes.startingNumber | Required | Must be an integer. Specify which number should be used as the starting point for your Auto-Number field. |
| customObjectField.autoNumberFieldAttributes.displayFormat | Required | Please refer to our guide: Custom Object Number Formats |
Formula Field
A field that is auto-calculated from other fields via a user-defined formula.
Request
https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectField.fieldLabel=Example Formula Column&customObjectField.fieldDescription=This is a formula field.&customObjectField.fieldHelpText=This field is calculated from a formula.&customObjectField.fieldDataType=FORMULA&customObjectField.isInternal=false&customObjectField.formulaFieldAttributes.formulaFieldReturnDataType=NUMBER&customObjectField.formulaFieldAttributes.formulaExpression= LENGTH(IFNULL( Auto_Number_c ,"abc"))Parameters
| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | FORMULA |
| customObjectField.formulaFieldAttributes.formulaFieldReturnDataType | Required | Possible values: BOOLEAN, NUMBER, PERCENT, TEXT, DATETIME, DATE. The data type that should be returned and displayed. |
| customObjectField.formulaFieldAttributes.returnDataDecimalLength | Required if formulaFieldReturnDataType is PERCENT or NUMBER. | The number of decimal places to return. |
| customObjectField.formulaFieldAttributes.emptyFieldTreatAs | Required | Possible values: ZEROS or BLANK. This determines whether blank data for this field will be intered into the database as a blank character or as zeroes matching your chosen decimal format. |
| customObjectField.formulaFieldAttributes.formulaExpression | Required | The formula to be used to calculate the value for this field. Use the formula building tool in NeonCRM’s custom objects interface to generate this formula. |
Master / Detail Field
This field creates a relationship between your custom object and another object. This may be a NeonCRM Standard Object (such as Accounts or Donations) or another custom object.
A one-to-many relationship, often referred to as a “Master-Details” or “Parent-Child” relationship, is the most usual relationship between two objects. When a parent record is deleted the child record has to be deleted. A child record cannot live without a parent record. A custom object can only have up to two (2) Master-Detail relationships.
Example in NeonCRM: Donor Account and Donation. A donation must have a donor. When a donor is deleted, the donations are also deleted.
Request
/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectField.fieldLabel=Example Master/Detail Field&customObjectField.fieldDescription=This is a Master/Detail field&customObjectField.fieldHelpText=Links this object to another object.&customObjectField.fieldDataType=MASTER_DETAIL&customObjectField.isInternal=false&customObjectField.masterDetailFieldAttributes.relatedObjectApiName=account_user&customObjectField.masterDetailFieldAttributes.reparentAllow=false&customObjectField.masterDetailFieldAttributes.deleteAction=BLOCK&customObjectField.masterDetailFieldAttributes.relationFilter.errorMessage=Errorrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr&customObjectField.masterDetailFieldAttributes.relationFilter.lookupWindowText=lookup text&customObjectField.masterDetailFieldAttributes.relationFilter.relationFilterJsonString=[{"criteriaField":"organizationType","operator":"In Range Of","type":"2","searchField":"","searchValue":"Association, Commercial Business, Corporate Sponsor, Government, Media, Not-for-profit, Religious Institution, School","groupId":1},{"criteriaField":"id","operator":"Not Blank","type":"1","searchField":"","searchValue":"","groupId":1},{"criteriaField":"email1","operator":"Containing","type":"2","searchField":"","searchValue":"test value","groupId":1},{"criteriaField":"companyName","operator":"Equal","type":"1","searchField":"lastName","searchValue":"","groupId":1}]
Parameters
| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | MASTER_DETAIL |
| customObjectField.masterDetailFieldAttributes.relatedObjectApiName | Required | Retrieve possible values from the List Master/Detail Objects API method. This is the object to which this object should become related. |
| customObjectField.masterDetailFieldAttributes.reparentAllow | Possible values: TRUE, FALSE. Determines whether or not this child object record can be reassigned to a different parent object record after it has been created. (Example: Donations cannot be assigned to a different account after they have been created.) | |
| customObjectField.masterDetailFieldAttributes.deleteAction | Required | Possible Values: CASCADE, BLOCK. Cascade Delete allows deletion of this object’s records when its parent object record is deleted. Block requires that all of this object’s records be deleted before it’s parent object record can be deleted. |
| customObjectField.masterDetailFieldAttributes.relationFilter.relationFilterJsonString | You can create a filter to limit the records available to users in the lookup field.To do this, use NeonCRM’s lookup filter builder in the system user interface and provide the resulting JSON string here. | |
| customObjectField.masterDetailFieldAttributes.relationFilter.errorMessage | Used if a lookup filter is defined. This message will display if the existing data on a Custom Object record no longer matches the defined search filter. | |
| customObjectField.masterDetailFieldAttributes.relationFilter.lookupWindowText | Used if a lookup filter is defined. Use this field to define the header content of the Lookup Window. The text in this field will only display when the search filter captures 300 or more options. |
Lookup Field
Lookup relationships work similarly to Master-Detail, but do not have the strong Parent-Child relationship. When a lookup parent record is deleted the child record remains with the parent reference emptied. A custom object can have many Lookup relationships.
Example in NeonCRM: Campaign and Donation. A donation does not have to have a campaign. When a campaign is deleted the linked donations are not deleted. However, the campaign previously associated with those donations is now emptied.
Request
/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectField.fieldLabel=Example Lookup Field&customObjectField.fieldDescription=This is a Lookup field&customObjectField.fieldHelpText=Looks up values from another object.&customObjectField.fieldDataType=LOOKUP&customObjectField.isInternal=false&customObjectField.lookupFieldAttributes.relatedObjectApiName=account_user&customObjectField.lookupFieldAttributes.reparentAllow=false&customObjectField.lookupFieldAttributes.relationFilter.errorMessage=You encountered an error.&customObjectField.lookupFieldAttributes.relationFilter.lookupWindowText=This is my lookup text.&customObjectField.lookupFieldAttributes.relationFilter.relationFilterJsonString=[{"criteriaField":"organizationType","operator":"In Range Of","type":"2","searchField":"","searchValue":"Association, Commercial Business, Corporate Sponsor, Government, Media, Not-for-profit, Religious Institution, School","groupId":1},{"criteriaField":"id","operator":"Not Blank","type":"1","searchField":"","searchValue":"","groupId":1},{"criteriaField":"email1","operator":"Containing","type":"2","searchField":"","searchValue":"sssss","groupId":1},{"criteriaField":"companyName","operator":"Equal","type":"1","searchField":"lastName","searchValue":"","groupId":1}]
Parameters
| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | LOOKUP |
| customObjectField.lookupFieldAttributes.relatedObjectApiName | Retrieve possible values from the List Lookup Objects API method. This is the object to which this object should become related. | |
| customObjectField.lookupFieldAttributes.reparentAllow | Possible values: TRUE, FALSE. Determines whether or not this child object record can be reassigned to a different parent object record after it has been created. (Example: Donations cannot be assigned to a different account after they have been created.) | |
| customObjectField.lookupFieldAttributes.relationFilter.relationFilterJsonString | You can create a filter to limit the records available to users in the lookup field.To do this, use NeonCRM’s lookup filter builder in the system user interface and provide the resulting JSON string here. | |
| customObjectField.lookupFieldAttributes.relationFilter.errorMessage | Used if a lookup filter is defined. This message will display if the existing data on a Custom Object record no longer matches the defined search filter. | |
| customObjectField.lookupFieldAttributes.relationFilter.lookupWindowText | Used if a lookup filter is defined. Use this field to define the header content of the Lookup Window. The text in this field will only display when the search filter captures 300 or more options. |
Text Field
A one-line text field.
Request
https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectField.fieldLabel=Text Column&customObjectField.fieldDescription=This is a text field&customObjectField.fieldHelpText=Type in some text here.&customObjectField.fieldDataType=TEXT&customObjectField.isInternal=false&customObjectField.textFieldAttributes.defaultValue=Awesome text!&customObjectField.textFieldAttributes.length=100&customObjectField.textFieldAttributes.isUnique=false&customObjectField.textFieldAttributes.isRequired=true
Parameters
| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | TEXT |
| customObjectField.textFieldAttributes.length | Required | The maximum length of the field. |
| customObjectField.textFieldAttributes.defaultValue | A default value shows up automatically on the data entry form. | |
| customObjectField.textFieldAttributes.isUnique | Possible values: TRUE, FALSE. When this is enabled, the field value must be unique in the entire custom object. A validation error will be thrown if duplicate values are detected. | |
| customObjectField.textFieldAttributes.isRequired | Possible values: TRUE, FALSE. Make this field required on the data entry form. |
Number Field
A number, integer, or decimal.
Request
https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectField.fieldLabel=Number Column&customObjectField.fieldDescription=This is a number field&customObjectField.fieldHelpText=Type in a number here.&customObjectField.fieldDataType=NUMBER&customObjectField.isInternal=false&customObjectField.numberFieldAttributes.defaultValue=5&customObjectField.numberFieldAttributes.length=12&customObjectField.numberFieldAttributes.decimalLength=0&customObjectField.numberFieldAttributes.isUnique=true&customObjectField.numberFieldAttributes.isRequired=false&customObjectField.numberFieldAttributes.displayFormat=######
Parameters
| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | NUMBER |
| customObjectField.numberFieldAttributes.defaultValue | A default value shows up automatically on the data entry form. | |
| customObjectField.numberFieldAttributes.length | Required | If your number is an integer, leave Decimal Places to 0. If it’s a decimal, populate the limit for both Integer Part and Decimal Places. Possible values: 0-15. |
| customObjectField.numberFieldAttributes.decimalLength | Required | The number of digits to the right of the decimal point. The combined length of the integer part and decimal places should be less than or equal to 15. |
| customObjectField.numberFieldAttributes.isUnique | Possible values: TRUE, FALSE. When this is enabled, the field value must be unique in the entire custom object. A validation error will be thrown if duplicate values are detected. | |
| customObjectField.numberFieldAttributes.isRequired | Possible values: TRUE, FALSE. Make this field required on the data entry form. | |
| customObjectField.numberFieldAttributes.displayFormat | Please refer to our guide: Custom Object Number Formats |
Email Field
An email field.
Request
https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectField.fieldLabel=Email Column&customObjectField.fieldDescription=This is an email field&customObjectField.fieldHelpText=Example: myname@gmail.com&customObjectField.fieldDataType=EMAIL&customObjectField.isInternal=false&customObjectField.emailFieldAttributes.defaultValue=nobody@gmail.com&customObjectField.emailFieldAttributes.isRequired=falseParameters
| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | |
| customObjectField.emailFieldAttributes.defaultValue | A default value shows up automatically on the data entry form. | |
| customObjectField.emailFieldAttributes.isRequired | Possible values: TRUE, FALSE. Make this field required on the data entry form. |
Phone Field
https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectField.fieldLabel=Phone Column&customObjectField.fieldDescription=This is a phone field&customObjectField.fieldHelpText=Example: 15555555545&customObjectField.fieldDataType=PHONE&customObjectField.isInternal=false&customObjectField.phoneFieldAttributes.defaultValue=15555555535&customObjectField.phoneFieldAttributes.isRequired=false| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | PHONE |
| customObjectField.phoneFieldAttributes.defaultValue | A default value shows up automatically on the data entry form. | |
| customObjectField.phoneFieldAttributes.isRequired | Possible values: TRUE, FALSE. Make this field required on the data entry form. |
URL Field
Request
https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectField.fieldLabel=URL Column&customObjectField.fieldDescription=This is a url field&customObjectField.fieldHelpText=Example: www.google.com&customObjectField.fieldDataType=URL&customObjectField.isInternal=false&customObjectField.urlFieldAttributes.defaultValue=www.google.com&customObjectField.urlFieldAttributes.isRequired=false
Parameters
| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | URL |
| customObjectField.urlFieldAttributes.defaultValue | A default value shows up automatically on the data entry form. | |
| customObjectField.urlFieldAttributes.isRequired | Possible values: TRUE, FALSE. Make this field required on the data entry form. |
Percent Field
A field to store percentage. For example, 90% is stored as 90 in a percentage field instead of 0.90.
Request
https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectField.fieldLabel=Percent Column&customObjectField.fieldDescription=This is a percent field&customObjectField.fieldHelpText=Example: 52&customObjectField.fieldDataType=PERCENT&customObjectField.isInternal=false&customObjectField.percentFieldAttributes.defaultValue=https://google.com&customObjectField.percentFieldAttributes.isRequired=false&customObjectField.percentFieldAttributes.length=5&customObjectField.percentFieldAttributes.decimalLength=2
Parameters
| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | PERCENT |
| customObjectField.percentFieldAttributes.defaultValue | A default value shows up automatically on the data entry form. | |
| customObjectField.percentFieldAttributes.isRequired | Possible values: TRUE, FALSE. Make this field required on the data entry form. | |
| customObjectField.percentFieldAttributes.length | Required | Character limit of the integer part. Possible values: 1-15. |
| customObjectField.percentFieldAttributes.decimalLength | Required | The number of digits to the right of the decimal point. The combined length of the integer part and decimal places should be less than or equal to 15. |
Textarea – Short Field
A short text area with a maximum length of 1024 characters.
Request
https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectField.fieldLabel=Favorite Novel&customObjectField.fieldDescription=Facorite Novel&customObjectField.fieldHelpText=Example: My favorite novel is The Sun Also Rises.&customObjectField.fieldDataType=TEXTAREA_SHORT&customObjectField.isInternal=false&customObjectField.textareaShortFieldAttributes.defaultValue=I have no favorite novel.&customObjectField.textareaShortFieldAttributes.isRequired=false&customObjectField.textareaShortFieldAttributes.length=100
Parameters
| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | TEXTAREA_SHORT |
| customObjectField.textareaShortFieldAttributes.defaultValue | A default value shows up automatically on the data entry form. | |
| customObjectField.textareaShortFieldAttributes.isRequired | Possible values: TRUE, FALSE. Make this field required on the data entry form. | |
| customObjectField.textareaShortFieldAttributes.length | Required | Must be less than or equal to 1024. |
Textarea Field
A standard text area field that supports up to 131072 characters.
Request
https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectField.fieldLabel=Favorite Novel&customObjectField.fieldDescription=Describe your favorite novel.&customObjectField.fieldHelpText=Example: My favorite novel is The Sun Also Rises.&customObjectField.fieldDataType=TEXTAREA&customObjectField.isInternal=false&customObjectField.textareaFieldAttributes.defaultValue=I have no favorite novel.&customObjectField.textareaFieldAttributes.isRequired=false&customObjectField.textareaFieldAttributes.length=1000
Parameters
| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | TEXTAREA |
| customObjectField.textareaFieldAttributes.defaultValue | A default value shows up automatically on the data entry form. | |
| customObjectField.textareaFieldAttributes.isRequired | Possible values: TRUE, FALSE. Make this field required on the data entry form. | |
| customObjectField.textareaFieldAttributes.length | Required | Must be less than or equal to 131072. |
Date Field
A field that tracks dates (05/20/2017).
Request
https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectField.fieldLabel=Date Column&customObjectField.fieldDescription=This is a date field&customObjectField.fieldHelpText=Example: 05/22/2017&customObjectField.fieldDataType=DATE&customObjectField.isInternal=false&customObjectField.dateFieldAttributes.defaultValue=05/12/2008&customObjectField.dateFieldAttributes.isRequired=false&customObjectField.dateFieldAttributes.displayFormat={MM}/{DD}/{YYYY}
Parameters
| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | DATE |
| customObjectField.dateFieldAttributes.defaultValue | A default value shows up automatically on the data entry form. | |
| customObjectField.dateFieldAttributes.isRequired | Possible values: TRUE, FALSE. Make this field required on the data entry form. | |
| customObjectField.dateFieldAttributes.displayFormat | Display format for this date. Example: {MM}/{DD}/{YYYY} results in 05/20/2017. |
Date + Time Field
A field that tracks both date and time.
Request
https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectField.fieldLabel=Date Time Column&customObjectField.fieldDescription=This is a date + time field&customObjectField.fieldHelpText=Example: 2008-05-12 14:27:59&customObjectField.fieldDataType=DATETIME&customObjectField.isInternal=false&customObjectField.datetimeFieldAttributes.defaultValue=2008-05-12 14:27:59&customObjectField.datetimeFieldAttributes.isRequired=false&customObjectField.datetimeFieldAttributes.displayFormat={YYYY}-{MM}-{DD} {HH}:{mm}:{ss}Parameters
| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | DATETIME |
| customObjectField.datetimeFieldAttributes.defaultValue | A default value shows up automatically on the data entry form. | |
| customObjectField.datetimeFieldAttributes.isRequired | Possible values: TRUE, FALSE. Make this field required on the data entry form. | |
| customObjectField.datetimeFieldAttributes.displayFormat | Display format for this date. Example: {MM}/{DD}/{YYYY} {HH}:{mm}:{ss} for 05/20/2017 14:02:20. |
Checkbox (single)
A simple ON / OFF boolean checkbox.
Request
https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectField.fieldLabel=Are you nice?&customObjectField.fieldDescription=This is a boolean field&customObjectField.fieldHelpText=Are you a nice person?&customObjectField.fieldDataType=CHECKBOX_SINGLE&customObjectField.isInternal=falseParameters
| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | CHECKBOX_SINGLE |
Checkbox List Field
A list of checkboxes.
Request
https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectField.fieldLabel=Colors I Like&customObjectField.fieldDescription=Colors the user likes.&customObjectField.fieldHelpText=Check the boxes next to colors you like.&customObjectField.fieldDataType=CHECKBOX&customObjectField.isInternal=false&customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.optionValue=Green&customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.sequence=1&customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.isActive=true&customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.isDefault=false&customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.optionValue=Red&customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.sequence=2&customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.isActive=false&customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.isDefault=false&customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.optionValue=Blue&customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.sequence=3&customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.isActive=true&customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.isDefault=true&customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.optionValue=Yellow&customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.sequence=1&customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.isActive=true&customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.isDefault=true
Parameters
| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | CHECKBOX |
| The following fields may be repeated multiple times in a single request. Complete each group of fields for each checkbox option added to the field: | ||
| customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.optionValue | Required | The name of the option to be displayed and used internally. |
| customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.sequence | Required | Must be an integer. Determines the order in which the options will display. |
| customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.isActive | Required | Possible values: TRUE, FALSE. Determines whether this value shows up on the data entry form. |
| customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.isDefault | Required | Possible values: TRUE, FALSE. Determines whether this option is checked by default on the data entry form. |
Dropdown Field
A dropdown menu field.
Request
https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectField.fieldLabel=Favorite Color&customObjectField.fieldDescription=The user's favorite color.&customObjectField.fieldHelpText=Select your favorite color.&customObjectField.fieldDataType=DROPDOWN&customObjectField.isInternal=false&customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.optionValue=Green&customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.sequence=1&customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.isActive=true&customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.isDefault=false&customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.optionValue=Red&customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.sequence=2&customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.isActive=false&customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.isDefault=false&customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.optionValue=Blue&customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.sequence=3&customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.isActive=true&customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.isDefault=true&customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.optionValue=Yellow&customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.sequence=1&customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.isActive=true&customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.isDefault=false
Parameters
| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | DROPDOWN |
| The following fields may be repeated multiple times in a single request. Complete each group of fields for each checkbox option added to the field: | ||
| customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.optionValue | Required | The name of the option to be displayed and used internally. |
| customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.sequence | Required | Must be an integer. Determines the order in which the options will display. |
| customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.isActive | Required | Possible values: TRUE, FALSE. Determines whether this value shows up on the data entry form. |
| customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.isDefault | Required | Possible values: TRUE, FALSE. Determines whether this option is checked by default on the data entry form. Only one option may be specified as the default. |
Radio Button List Field
A list of radio buttons.
Request
https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectField.fieldLabel=Favorite Color&customObjectField.fieldDescription=The user's favorite color.&customObjectField.fieldHelpText=Select your favorite color.&customObjectField.fieldDataType=RADIO&customObjectField.isInternal=false&customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.optionValue=Green&customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.sequence=1&customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.isActive=true&customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.isDefault=false&customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.optionValue=Red&customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.sequence=2&customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.isActive=false&customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.isDefault=false&customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.optionValue=Blue&customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.sequence=3&customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.isActive=true&customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.isDefault=true&customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.optionValue=Yellow&customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.sequence=1&customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.isActive=true&customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.isDefault=false
File Upload Field
https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectField?userSessionId=[session id]| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | FILE_UPLOAD |
| customObjectField.fileUploadFieldAttributes.isRequired | Required | Possible values: TRUE, FALSE. Make this field required on the data entry form. |
| customObjectField.fileUploadFieldAttributes.maxFileSize | Required | Maximum allowed file size. |
| customObjectField.fileUploadFieldAttributes.allowFileTypes | Required | A list of available file types that should be accepted by the field. |
| customObjectField.fileUploadFieldAttributes.availableToPublic | Required | Possible values: TRUE, FALSE. Whether the field should be available on public forms. |
Parameters
| Parameter | Required | Description |
|---|---|---|
| customObjectField.fieldDataType | Required | RADIO |
| The following fields may be repeated multiple times in a single request. Complete each group of fields for each checkbox option added to the field: | ||
| customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.optionValue | Required | The name of the option to be displayed and used internally. |
| customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.sequence | Required | Must be an integer. Determines the order in which the options will display. |
| customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.isActive | Required | Possible values: TRUE, FALSE. Determines whether this value shows up on the data entry form. |
| customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.isDefault | Required | Possible values: TRUE, FALSE. Determines whether this option is checked by default on the data entry form. Only one option may be specified as the default. |
Response
{
"createCustomObjectFieldResponse": {
"operationResult": "SUCCESS",
"responseDateTime": "2017-05-19T18:34:28.871+0000"
}
}Error Codes
| Code | Text | Description |
|---|---|---|
| 20001 | Object API name is required. | |
| 20002 | Object API name is invalid. | |
| 20020 | Object is active. | |
| 20032 | Object field data type is required. | |
| 20033 | Object field data type is invalid. | |
| 20034 | Auto number attributes are required. | |
| 20035 | Formula attributes are required. | |
| 20050 | Looklup attributes are required. | |
| 20049 | Master detail attributes are required. | |
| 20036 | Text attributes are required. | |
| 20037 | Number attributes are required. | |
| 20038 | Email attributes are required. | |
| 20039 | Phone attributes are required. | |
| 20040 | Url attributes are required. | |
| 20041 | Percent attributes are required. | |
| 20042 | Textarea short attributes are required. | |
| 20043 | Textarea attributes are required. | |
| 20044 | Picklist attributes are required. | |
| 20045 | Date attributes are required. | |
| 20046 | Datetime attributes are required. | |
| 20047 | Radio attributes are required. | |
| 20048 | Checkbox attributes are required. | |
| 20051 | Formula Json string is invalid. |