API v1 Reference

Update Custom Object Validator

Update an existing data validation rule.

Endpoint

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

Request

https://api.neoncrm.com/neonws/services/api/customObject/updateCustomObjectValidator?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&customObjectValidator.validatorName=NumberGreatherThanOneThousand&customObjectValidator.errorMessage=Your number must be greater than 1001.&customObjectValidator.description=Ensures numbers are greater than 1001.&customObjectValidator.validatorExpression=Number_Column111_c  > 1001&customObjectValidator.isActive=false

Response

{
  "updateCustomObjectValidatorResponse": {
    "operationResult": "SUCCESS",
    "responseDateTime": "2017-05-24T21:53:09.004+0000"
  }
}

Request Parameters

Parameter Required Description
objectApiName Required This is the token used to identify the Custom Object when accessing it from the API.
customObjectValidator.id Required The ID of the validator to be updated. IDs can be retrieved using the List Custom Object Validators API method.
customObjectValidator.validatorName You can define multiple validation rules. This is an internal name only used on the NeonCRM back end to distinguish this rule from others.
customObjectValidator.errorMessage This validator error message will display on the data entry form if the data on a Custom Object record no longer matches the defined formula (fails validation).
customObjectValidator.description This is the internal text that describes this validation rule. This is not the actual error message shown to a system user.
customObjectValidator.validatorExpression The formula used to determine whether data passes this particular validation rule. Use the formula building interface in NeonCRM to create your formula and provide it here.
customObjectValidator.isActive Possible values: TRUE, FALSE. Enables the validation rule.

Error Codes

Code Text Description