Account & Settings
Gestión de aplicaciones
Autenticación
Automatización
CMS
Communication preferences
Conversaciones
CRM
Eventos
Archivos
Marketing
Crear informes
Scheduler
curl --request POST \
--url https://api.hubapi.com/crm/v3/properties/{objectType} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayOrder": 2,
"fieldType": "select",
"formField": true,
"groupName": "contactinformation",
"hasUniqueValue": false,
"hidden": false,
"label": "My Contact Property",
"name": "my_contact_property",
"options": [
{
"description": "Choice number one",
"displayOrder": 1,
"hidden": false,
"label": "Option A",
"value": "A"
},
{
"description": "Choice number two",
"displayOrder": 2,
"hidden": false,
"label": "Option B",
"value": "B"
}
],
"type": "enumeration"
}
'{
"displayOrder": 2,
"fieldType": "select",
"formField": true,
"groupName": "contactinformation",
"hasUniqueValue": false,
"hidden": false,
"label": "My Contact Property",
"modificationMetadata": {
"archivable": true,
"readOnlyDefinition": false,
"readOnlyOptions": false,
"readOnlyValue": false
},
"name": "my_contact_property",
"options": [
{
"description": "Choice number one",
"displayOrder": 1,
"hidden": false,
"label": "Option A",
"value": "A"
},
{
"description": "Choice number two",
"displayOrder": 2,
"hidden": false,
"label": "Option B",
"value": "B"
}
],
"type": "enumeration"
}Create a property
Crea y devuelve una copia de una nueva propiedad para el tipo de objeto especificado.
curl --request POST \
--url https://api.hubapi.com/crm/v3/properties/{objectType} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayOrder": 2,
"fieldType": "select",
"formField": true,
"groupName": "contactinformation",
"hasUniqueValue": false,
"hidden": false,
"label": "My Contact Property",
"name": "my_contact_property",
"options": [
{
"description": "Choice number one",
"displayOrder": 1,
"hidden": false,
"label": "Option A",
"value": "A"
},
{
"description": "Choice number two",
"displayOrder": 2,
"hidden": false,
"label": "Option B",
"value": "B"
}
],
"type": "enumeration"
}
'{
"displayOrder": 2,
"fieldType": "select",
"formField": true,
"groupName": "contactinformation",
"hasUniqueValue": false,
"hidden": false,
"label": "My Contact Property",
"modificationMetadata": {
"archivable": true,
"readOnlyDefinition": false,
"readOnlyOptions": false,
"readOnlyValue": false
},
"name": "my_contact_property",
"options": [
{
"description": "Choice number one",
"displayOrder": 1,
"hidden": false,
"label": "Option A",
"value": "A"
},
{
"description": "Choice number two",
"displayOrder": 2,
"hidden": false,
"label": "Option B",
"value": "B"
}
],
"type": "enumeration"
}Supported products
Supported products
Required Scopes
Required Scopes
Autorizaciones
The access token received from the authorization server in the OAuth 2.0 flow.
Parámetros de ruta
El tipo de objeto para el que se está creando una nueva propiedad.
Cuerpo
Controla cómo aparece la propiedad en HubSpot.
booleancheckbox, calculation_equation, checkbox, date, file, html, number, phonenumber, radio, select, text, textarea El nombre del grupo de propiedades al que pertenece la propiedad.
Una etiqueta de propiedad legible para humanos que se mostrará en HubSpot.
El nombre interno de la propiedad, que debe usarse al referenciar la propiedad a través de la API.
El tipo de datos de la propiedad.
bool, date, datetime, enumeration, number, phone_number, string Representa una fórmula que se utiliza para calcular una propiedad calculada.
Indica el nivel de sensibilidad de la propiedad, con las siguientes opciones: highly_sensitive, non_sensitive o sensitive.
highly_sensitive, non_sensitive, sensitive Una descripción de la propiedad que se mostrará como texto de ayuda en HubSpot.
Las propiedades se muestran en orden, comenzando con el valor entero positivo más bajo. Los valores de -1 harán que la propiedad se muestre después de todos los valores positivos.
Aplicable solo para propiedades de tipo "enumeración". Debe establecerse en verdadero en conjunto con un "referenteObjectType" de "PROPIETARIO". De lo contrario, en falso.
Si la propiedad se puede usar en un formulario de HubSpot o no.
Si el valor de la propiedad debe ser único o no. Una vez establecido, esto no se puede cambiar.
Si es verdadero, la propiedad no será visible y no se podrá usar en HubSpot.
currency, duration, formatted, percentage, probability, unformatted Una lista de opciones válidas para la propiedad. Este campo es obligatorio para las propiedades enumeradas.
Show child attributes
Show child attributes
Debe establecerse en "PROPIETARIO" cuando "externalOptions" es verdadero, lo que hace que la propiedad extraiga dinámicamente los valores de opción de los usuarios actuales de HubSpot.
Respuesta
successful operation
Propiedad de HubSpot
Una descripción de la propiedad que se mostrará como texto de ayuda en HubSpot.
Controla cómo aparece la propiedad en HubSpot.
El nombre del grupo de propiedades al que pertenece la propiedad.
Una etiqueta de propiedad legible para humanos que se mostrará en HubSpot.
El nombre interno de la propiedad, que debe usarse al referenciar la propiedad a través de la API.
Una lista de opciones válidas para la propiedad. Este campo es obligatorio para las propiedades enumeradas, pero estará vacío para otros tipos de propiedad.
Show child attributes
Show child attributes
El tipo de datos de la propiedad.
Si la propiedad se archiva o no.
Cuando se archivó la propiedad.
Para las propiedades predeterminadas, true indica que la propiedad es calculada por un proceso de HubSpot. No tiene ningún efecto para las propiedades personalizadas.
Representa una fórmula que se utiliza para calcular una propiedad calculada.
La marca de tiempo en la que se creó la propiedad, en formato ISO 8601.
El ID interno del usuario que creó la propiedad en HubSpot. Este campo puede no existir si la propiedad se creó fuera de HubSpot.
El nombre de la propiedad de divisa relacionada.
Indica el nivel de sensibilidad de la propiedad, como "non_sensitive", "sensitive", or "highly_sensitive".
highly_sensitive, non_sensitive, sensitive Indica cómo se deben mostrar los valores de fecha, con opciones como "absolute", "absolute_with_relative", "time_since" o "time_until".
absolute, absolute_with_relative, time_since, time_until Las propiedades se muestran en orden, comenzando con el valor entero positivo más bajo.
Para las propiedades predeterminadas, verdadero indica que las opciones se almacenan fuera de la configuración de la propiedad.
Si la propiedad se puede usar en un formulario de HubSpot o no.
Si el valor de la propiedad debe ser único o no. Una vez establecido, esto no se puede cambiar.
Si la propiedad se ocultará o no de la UI de HubSpot. Se recomienda que esto se establezca en falso para las propiedades personalizadas.
false
Esto será verdadero para las propiedades de objeto predeterminadas integradas en HubSpot.
Show child attributes
Show child attributes
Sugerencia sobre cómo se muestra y valida una propiedad numérica en la IU de HubSpot. Puede ser: "unformatted", "formatted", "currency", "percentage", "duration" o "probability".
currency, duration, formatted, percentage, probability, unformatted Si esta propiedad está relacionada con otros objetos, esos objetos se mostrarán aquí.
Cuando sensitiveData es verdadero, enumera el tipo de datos sensibles contenidos en la propiedad (por ejemplo, "HIPAA").
Si la propiedad mostrará o no el símbolo de divisa en la configuración de la cuenta.
La marca de tiempo en la que se actualizó la propiedad, en formato ISO 8601.
El ID interno del usuario que creó la propiedad en HubSpot. Este campo puede no existir si la propiedad se actualizó fuera de HubSpot.