HubSpot: Property validations schemas

← Property validations operations · All schemas

Read all property validation rules for an object — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	Collection of properties with their validation rules. Each item maps a property name to its configured validation rules for the specified object type.
results[]	Model	Each item	Expand Read all property validation rules for an object — response body — results item

Referenced models: Read all property validation rules for an object — response body — results item

Read all property validation rules for an object — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
propertyName	string	Required within parent	The name of the property for which validation rules are defined.
propertyValidationRules	array	Required within parent	A list of validation rules applicable to the property.
propertyValidationRules[]	Model	Each item	Expand Retrieve a validation rule for a specific property and rule type, providing details on how property values should be formatted — response body

Referenced models: Retrieve a validation rule for a specific property and rule type, providing details on how property values should be formatted — response body

Read validation rules for a property — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	Collection of validation rules configured for the specified property. Each rule defines a constraint that property values must satisfy (e.g., format requirements, length limits, allowed values).
results[]	Model	Each item	Expand Retrieve a validation rule for a specific property and rule type, providing details on how property values should be formatted — response body

Referenced models: Retrieve a validation rule for a specific property and rule type, providing details on how property values should be formatted — response body

Retrieve a validation rule for a specific property and rule type, providing details on how property values should be formatted — response body

Field	Type	Presence	Description and constraints
$	object	Root
ruleArguments	array	Required within parent	A list of arguments that define the specific conditions or parameters for the validation rule.
ruleArguments[]	string	Each item
ruleType	string	Required within parent	The category of validation applied to the property, such as FORMAT, ALPHANUMERIC, or MAX_LENGTH. Known values: AFTER_DATETIME_DURATION, AFTER_DURATION, ALPHANUMERIC, BEFORE_DATETIME_DURATION, BEFORE_DURATION, DAYS_OF_WEEK, DECIMAL, DOMAIN, EMAIL, EMAIL_ALLOWED_DOMAINS, EMAIL_BLOCKED_DOMAINS, END_DATE, END_DATETIME, FORMAT, MAX_LENGTH, MAX_NUMBER, MIN_LENGTH, MIN_NUMBER, PHONE_NUMBER_WITH_EXPLICIT_COUNTRY_CODE, REGEX, SPECIAL_CHARACTERS, START_DATE, START_DATETIME, URL, URL_ALLOWED_DOMAINS, URL_BLOCKED_DOMAINS, WHITESPACE
shouldApplyNormalization	boolean	Optional	A boolean indicating whether normalization should be applied to the property value before validation.

Update a validation rule for a specific property and rule type, allowing customization of property value constraints — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
ruleArguments	array	Required within parent	A list of arguments that define the constraints for the validation rule.
ruleArguments[]	string	Each item
shouldApplyNormalization	boolean	Optional	A boolean indicating whether normalization should be applied to the property value as part of the validation process.

Update a validation rule for a specific property and rule type, allowing customization of property value constraints — request body — path

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
objectTypeId	string	Required within parent
propertyName	string	Required within parent
ruleType	string	Required within parent	One of: AFTER_DATETIME_DURATION, AFTER_DURATION, ALPHANUMERIC, BEFORE_DATETIME_DURATION, BEFORE_DURATION, DAYS_OF_WEEK, DECIMAL, DOMAIN, EMAIL, EMAIL_ALLOWED_DOMAINS, EMAIL_BLOCKED_DOMAINS, END_DATE, END_DATETIME, FORMAT, MAX_LENGTH, MAX_NUMBER, MIN_LENGTH, MIN_NUMBER, PHONE_NUMBER_WITH_EXPLICIT_COUNTRY_CODE, REGEX, SPECIAL_CHARACTERS, START_DATE, START_DATETIME, URL, URL_ALLOWED_DOMAINS, URL_BLOCKED_DOMAINS, WHITESPACE