The property validations endpoints allow you to view validation rules for your properties.
GET
request to /crm/v3/property-validations/{objectTypeId}
. Refer to this guide for a full list of objectTypeId
values.
Properties with validation rules are returned with the following fields:
propertyName
: the name of the property with validation rules.propertyValidationRules
: an array with the rules set for the property. Includes each rule’s ruleType
(the category for the rule) and ruleArguments
(specific requirements of the rule).GET
request to /crm/v3/property-validations/0-1
. In the following response, there are two properties with rules, the zip
(Postal Code) property which only allows numeric characters and the age
property which requires a minimum value of 1.
GET
request to /crm/v3/property-validations/{objectTypeId}/{propertyName}
. You can refer to this guide for a full list of objectTypeId
values and use the Properties API to retrieve propertyName
values.
The property’s rules are returned with the ruleType
and ruleArguments
for each.
For example, to view validation rules for an Order ID deal property, make a GET
request to /crm/v3/property-validations/0-3/order_id
. In the following response, the property has three rules that require the value to contain between one and eight numeric characters.