Passer au contenu principal
GET
/
crm
/
v3
/
property-validations
/
{objectTypeId}
/
{propertyName}
/
rule-type
/
{ruleType}
Récupérer une règle de validation pour une propriété et un type de règle spécifiques, fournissant des détails sur la manière dont les valeurs de propriété doivent être formatées.
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
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Gratuit
Sales HubSales Hub -Gratuit
Service HubService Hub -Gratuit
Content HubContent Hub -Gratuit

Autorisations

Authorization
string
header
requis

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

Paramètres de chemin

objectTypeId
string
requis

L'ID du type d'objet auquel appartient la propriété.

propertyName
string
requis

Le nom de la propriété pour laquelle la règle de validation est récupérée.

ruleType
enum<string>
requis

Le type de règle de validation récupérée, tel que FORMAT, ALPHANUMERIC ou MAX_LENGTH.

Options disponibles:
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

Réponse

successful operation

ruleArguments
string[]
requis

Liste des arguments qui définissent les conditions ou paramètres spécifiques de la règle de validation.

ruleType
enum<string>
requis

La catégorie de validation appliquée à la propriété, telle que FORMAT, ALPHANUMERIC ou MAX_LENGTH.

Options disponibles:
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