ValidationRules
Update ValidationRule
Update an existing ValidationRule record.
PUT
Update ValidationRule
Updates an existing ValidationRule record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the ValidationRule-Edit role.Enums
eValidationRuleEntity — RecordType values
eValidationRuleEntity — RecordType values
Request Body
Required Fields
integer
required
The Id of the ValidationRule record to update.
integer
required
ID of the business linked to this record.
string
required
The name value for this validation rule.
integer
required
The record type value for this validation rule.
string
required
The formula value for this validation rule.
Optional Fields
boolean
Whether this validation rule is currently active.
string
Free-text description of this validation rule.
string
The error message value for this validation rule.
Code Examples
Response
200
integer
HTTP status code.
200 on success.string
A human-readable message confirming the update.
object
Contains the
Id of the updated record.boolean
true if the validationrule was updated successfully.array
null on success.Example Response
400
string
A summary of the validation error(s), in the format
PropertyName: error message.any
null on validation failure.object[]
Array of validation errors.
boolean
false when the request fails validation.Example Response
Update ValidationRule