Skip to main content
GET
/
crm
/
v3
/
property-validations
/
{objectTypeId}
/
{propertyName}
/
rule-type
/
{ruleType}
Obtener una regla de validación para una propiedad y un tipo de regla específicos, que proporcione detalles sobre cómo deben formatearse los valores de la propiedad.
curl --request GET \
  --url https://api.hubapi.com/crm/v3/property-validations/{objectTypeId}/{propertyName}/rule-type/{ruleType} \
  --header 'private-app: <api-key>'
{
  "ruleType": "FORMAT",
  "ruleArguments": [
    "<string>"
  ]
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Gratuito
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito
Esta API requiere uno de los siguientes ámbitos:
automation
crm.objects.appointments.read
crm.objects.appointments.sensitive.read.v2
crm.objects.appointments.sensitive.write.v2
crm.objects.appointments.write
crm.objects.carts.read
crm.objects.commercepayments.write
crm.objects.companies.highly_sensitive.read.v2
crm.objects.companies.highly_sensitive.write.v2
crm.objects.companies.read
crm.objects.companies.sensitive.read.v2
crm.objects.companies.sensitive.write.v2
crm.objects.companies.write
crm.objects.contacts.highly_sensitive.read.v2
crm.objects.contacts.highly_sensitive.write.v2
crm.objects.contacts.read
crm.objects.contacts.sensitive.read.v2
crm.objects.contacts.sensitive.write.v2
crm.objects.contacts.write
crm.objects.courses.read
crm.objects.courses.write
crm.objects.custom.highly_sensitive.read.v2
crm.objects.custom.highly_sensitive.write.v2
crm.objects.custom.read
crm.objects.custom.sensitive.read.v2
crm.objects.custom.sensitive.write.v2
crm.objects.custom.write
crm.objects.deals.highly_sensitive.read.v2
crm.objects.deals.highly_sensitive.write.v2
crm.objects.deals.read
crm.objects.deals.sensitive.read.v2
crm.objects.deals.sensitive.write.v2
crm.objects.deals.write
crm.objects.feedback_submissions.read
crm.objects.goals.read
crm.objects.goals.write
crm.objects.invoices.read
crm.objects.invoices.write
crm.objects.leads.read
crm.objects.leads.write
crm.objects.line_items.read
crm.objects.line_items.write
crm.objects.listings.read
crm.objects.listings.write
crm.objects.marketing_events.read
crm.objects.marketing_events.write
crm.objects.orders.read
crm.objects.owners.read
crm.objects.products.write
crm.objects.quotes.read
crm.objects.quotes.write
crm.objects.services.read
crm.objects.services.write
crm.objects.subscriptions.read
crm.objects.subscriptions.write
crm.objects.users.read
crm.pipelines.orders.read
crm.schemas.appointments.read
crm.schemas.carts.read
crm.schemas.commercepayments.read
crm.schemas.companies.read
crm.schemas.contacts.read
crm.schemas.courses.read
crm.schemas.custom.read
crm.schemas.deals.read
crm.schemas.invoices.read
crm.schemas.line_items.read
crm.schemas.listings.read
crm.schemas.orders.read
crm.schemas.quotes.read
crm.schemas.services.read
crm.schemas.subscriptions.read
e-commerce
media_bridge.read
tickets
tickets.highly_sensitive.v2
tickets.sensitive.v2
timeline

Authorizations

​
private-app
string
header
required

Path Parameters

​
objectTypeId
string
required

El ID del tipo de objeto al que pertenece la propiedad.

​
propertyName
string
required

El nombre de la propiedad para la que se está obteniendo la regla de validación.

​
ruleType
enum<string>
required

El tipo de regla de validación que se está obteniendo, como FORMAT, ALPHANUMERIC o MAX_LENGTH.

Available options:
FORMAT,
ALPHANUMERIC,
MAX_LENGTH,
MIN_LENGTH,
MIN_NUMBER,
MAX_NUMBER,
START_DATE,
END_DATE,
SPECIAL_CHARACTERS,
WHITESPACE,
DECIMAL,
BEFORE_DURATION,
AFTER_DURATION,
DAYS_OF_WEEK,
REGEX,
START_DATETIME,
END_DATETIME,
BEFORE_DATETIME_DURATION,
AFTER_DATETIME_DURATION,
PHONE_NUMBER_WITH_EXPLICIT_COUNTRY_CODE,
URL,
URL_ALLOWED_DOMAINS,
URL_BLOCKED_DOMAINS,
EMAIL,
EMAIL_ALLOWED_DOMAINS,
EMAIL_BLOCKED_DOMAINS,
DOMAIN

Response

successful operation

​
ruleType
enum<string>
required

La categoría de validación aplicada a la propiedad, como FORMAT, ALPHANUMERIC o MAX_LENGTH.

Available options:
FORMAT,
ALPHANUMERIC,
MAX_LENGTH,
MIN_LENGTH,
MIN_NUMBER,
MAX_NUMBER,
START_DATE,
END_DATE,
SPECIAL_CHARACTERS,
WHITESPACE,
DECIMAL,
BEFORE_DURATION,
AFTER_DURATION,
DAYS_OF_WEEK,
REGEX,
START_DATETIME,
END_DATETIME,
BEFORE_DATETIME_DURATION,
AFTER_DATETIME_DURATION,
PHONE_NUMBER_WITH_EXPLICIT_COUNTRY_CODE,
URL,
URL_ALLOWED_DOMAINS,
URL_BLOCKED_DOMAINS,
EMAIL,
EMAIL_ALLOWED_DOMAINS,
EMAIL_BLOCKED_DOMAINS,
DOMAIN
​
ruleArguments
string[]
required

Una lista de argumentos que definen las condiciones o parámetros específicos para la regla de validación.