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

Rufen Sie eine spezifische Validierungsregel für eine Eigenschaft ab, die durch ihren Namen und Regeltyp identifiziert ist.

GET /crm/property-validations/2026-03/{objectTypeId}/{propertyName}/rule-type/{ruleType}

Rufen Sie eine Validierungsregel für eine spezifische Eigenschaft und einen Regeltyp ab, und geben Sie Details zur Formatierung dieser Eigenschaftswerte an.

cURL

curl --request GET \
  --url https://api.hubapi.com/crm/property-validations/2026-03/{objectTypeId}/{propertyName}/rule-type/{ruleType} \
  --header 'Authorization: Bearer <token>'

200

{
  "ruleArguments": [
    "<string>"
  ],
  "ruleType": "AFTER_DATETIME_DURATION",
  "shouldApplyNormalization": true
}

Supported products

Required Scopes

Autorisierungen

Authorization · string · header · erforderlich

The access token received from the authorization server in the OAuth 2.0 flow.

Pfadparameter

objectTypeId · string · erforderlich

propertyName · string · erforderlich

ruleType · enum<string> · erforderlich

Verfügbare Optionen: 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

Antwort

200

application/json

successful operation

ruleArguments · string[] · erforderlich

Eine Liste von Argumenten, die die spezifischen Bedingungen oder Parameter für die Validierungsregel definieren.

ruleType · enum<string> · erforderlich

Die Validierungskategorie, die auf die Eigenschaft angewendet wird, z. B. „FORMAT“, „ALPHANUMERIC“ oder „MAX_LENGTH“.

Verfügbare Optionen: 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