Update Custom Object

Updates the configuration of an existing custom object.

This API method supports partial updating. This means that you only need to send fields you wish to change. Sending a field with a blank value will overwrite the existing value with empty data.

Important: An object must be inactive before you can modify it.

Endpoint

https://api.neoncrm.com/neonws/services/api/customObject/updateCustomObject

Request

https://api.neoncrm.com/neonws/services/api/customObject/updateCustomObject?userSessionId=[session id]&customObject.objectLabel=Museum Visits&customObject.objectId=2

Response

{
  "updateCustomObjectResponse": {
    "operationResult": "SUCCESS",
    "responseDateTime": "2017-05-18T21:26:37.636+0000"
  }
}

Request Parameters

Parameter Required Description
customObject.objectId Required The ID of the object to be updated.
customObject.objectLabel This is the unique name used to identify the Custom Object in the Custom Objects list as well as in the left menu (if the object is added to the left menu).
customObject.objectDescription Optional description or notes about this Custom Object.
customObject.objectRecordName This is a non-unique Field Name for the First Record that appears in page layouts, key lists, related lists, lookups, and search results. This is the first column to be created in your table. In most cases, this will be your table’s primary key.
customObject.objectRecordDataType Possible values: TEXT or AUTO_NUMBER. This controls the data type for the column you created with the “customObject.objectRecordName” parameter. In most cases, you will want to use a value of 1 (Auto-Number).
customObject.ObjectRecordStartNumber Used if customObject.objectRecordDataType = 1. Must be an integer. Specify which number should be used as the starting point for your Auto-Number field.
customObject.objectRecordDisplayFormat Please refer to our guide: Custom Object Number Formats

customObject.AllowActivity Possible values: TRUE, FALSE. If this is turned on, this Custom Object will be available for use in Activities.
customObject.AllowReport Possible values: TRUE, FALSE. If this is turned on, this Custom Object will be exposed to the NeonCRM reporting interface.
customObject.addToNeonLeftMenu Possible values: TRUE, FALSE. If this is turned on, this Custom Object will be added to NeonCRM’s left-side navigation menu.
customObject.createWebhook Format: Valid URL. When a new record is created, Neon will pass the record as JSON to this URL.
customObject.updateWebhook Format: Valid URL. When a record is updated, Neon will pass the record as JSON to this URL.
customObject.deleteWebhook Format: Valid URL. When a record is deleted, Neon will pass the record ID as JSON to this URL.
customObject.isActive Possible values: TRUE, FALSE. Inactive Custom Objects are not visible to system users.

Error Codes

Code Text Description
20008 Object label name is required.
20009 Object label name is invalid.
20010 Object record name is requried.
20011 Object record name is invalid.
20012 Object record data type is required.
20013 Object record data type is invalid.
20014 Object record display format is required.
20016 Object record start number is required.
20017 Object record start number is invalid.
20018 Object id is requried.
20020 Object is active.
20019 Object id is invalid.