Pular para o conteúdo principal
GET
/
crm
/
v3
/
property-validations
/
{objectTypeId}
/
{propertyName}
/
rule-type
/
{ruleType}
Recupere uma regra de validação para uma propriedade e tipo de regra específicos, fornecendo detalhes sobre como os valores da propriedade devem ser formatados.
curl --request GET \
  --url https://api.hubapi.com/crm/v3/property-validations/{objectTypeId}/{propertyName}/rule-type/{ruleType} \
  --header 'Authorization: Bearer <token>'
{
  "ruleArguments": [
    "<string>"
  ],
  "ruleType": "AFTER_DATETIME_DURATION",
  "shouldApplyNormalization": true
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Grátis
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Grátis

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

objectTypeId
string
obrigatório

O ID do tipo de objeto ao qual a propriedade pertence.

propertyName
string
obrigatório

O nome da propriedade para a qual a regra de validação está sendo recuperada.

ruleType
enum<string>
obrigatório

O tipo de regra de validação que está sendo recuperada, por exemplo: FORMAT, ALPHANUMERIC ou MAX_LENGTH.

Opções disponíveis:
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

Resposta

successful operation

ruleArguments
string[]
obrigatório

Uma lista de argumentos que definem as condições ou parâmetros específicos para a regra de validação.

ruleType
enum<string>
obrigatório

A categoria de validação aplicada à propriedade, como FORMAT, ALPHANUMERIC ou MAX_LENGTH.

Opções disponíveis:
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
Last modified on December 8, 2025