Saltar al contenido principal
POST
/
crm
/
v3
/
properties
/
{objectType}
Crear una propiedad
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"
}

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

Autorizaciones

​
Authorization
string
header
requerido

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

Parámetros de ruta

​
objectType
string
requerido

El tipo de objeto para el que se está creando una nueva propiedad.

Cuerpo

application/json
​
fieldType
enum<string>
requerido

Controla cómo aparece la propiedad en HubSpot.

Opciones disponibles:
booleancheckbox,
calculation_equation,
checkbox,
date,
file,
html,
number,
phonenumber,
radio,
select,
text,
textarea
​
groupName
string
requerido

El nombre del grupo de propiedades al que pertenece la propiedad.

​
label
string
requerido

Una etiqueta legible para humanos que se mostrará en HubSpot.

​
name
string
requerido

El nombre de la propiedad que se leerá o modificará.

​
type
enum<string>
requerido

El tipo de datos de la propiedad.

Opciones disponibles:
bool,
date,
datetime,
enumeration,
number,
phone_number,
string
​
calculationFormula
string

Representa una fórmula que se utiliza para calcular una propiedad calculada.

​
dataSensitivity
enum<string>

Indica el nivel de sensibilidad de la propiedad, con las siguientes opciones: highly_sensitive, non_sensitive o sensitive.

Opciones disponibles:
highly_sensitive,
non_sensitive,
sensitive
​
description
string

Una descripción de la propiedad que se mostrará como texto de ayuda en HubSpot.

​
displayOrder
integer<int32>

Los grupos de propiedades se muestran en orden, comenzando con el valor entero positivo más bajo. Los valores de -1 harán que el grupo de propiedades se muestre después de todos los valores positivos.

​
externalOptions
boolean

Aplicable solo para propiedades de tipo "enumeración". Debe establecerse en verdadero en conjunto con un "referenteObjectType" de "PROPIETARIO". De lo contrario, en falso.

​
formField
boolean

Si la propiedad se puede usar en un formulario de HubSpot o no.

​
hasUniqueValue
boolean

Si el valor de la propiedad debe ser único o no. Una vez establecido, esto no se puede cambiar.

​
hidden
boolean

Si es verdadero, la propiedad no será visible y no se podrá usar en HubSpot.

​
options
object[]

Una lista de opciones válidas para la propiedad. Este campo es obligatorio para las propiedades enumeradas.

​
referencedObjectType
string

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

​
description
string
requerido

Una descripción de la propiedad que se mostrará como texto de ayuda en HubSpot.

​
fieldType
string
requerido

Controla cómo aparece la propiedad en HubSpot.

​
groupName
string
requerido

El nombre del grupo de propiedades al que pertenece la propiedad.

​
label
string
requerido

Una etiqueta legible para humanos que se mostrará en HubSpot.

​
name
string
requerido

El nombre de la propiedad que se leerá o modificará.

​
options
object[]
requerido

Una lista de opciones válidas para la propiedad. Este campo es obligatorio para las propiedades enumeradas.

​
type
string
requerido

El tipo de datos de la propiedad.

​
archived
boolean

Si la propiedad se archiva o no.

​
archivedAt
string<date-time>

Cuando se archivó la propiedad.

​
calculated
boolean

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.

​
calculationFormula
string

Representa una fórmula que se utiliza para calcular una propiedad calculada.

​
createdAt
string<date-time>

La marca de tiempo en la que se creó la propiedad, en formato ISO 8601.

​
createdUserId
string

El ID interno del usuario que creó la propiedad en HubSpot. Este campo puede no existir si la propiedad se creó fuera de HubSpot.

​
dataSensitivity
enum<string>

Indica el nivel de sensibilidad de la propiedad, como "non_sensitive", "sensitive", or "highly_sensitive".

Opciones disponibles:
highly_sensitive,
non_sensitive,
sensitive
​
dateDisplayHint
enum<string>

Indica cómo se deben mostrar los valores de fecha, con opciones como "absolute", "absolute_with_relative", "time_since" o "time_until".

Opciones disponibles:
absolute,
absolute_with_relative,
time_since,
time_until
​
displayOrder
integer<int32>

Los grupos de propiedades se muestran en orden, comenzando con el valor entero positivo más bajo. Los valores de -1 harán que el grupo de propiedades se muestre después de todos los valores positivos.

​
externalOptions
boolean

Aplicable solo para propiedades de tipo "enumeración". Debe establecerse en verdadero en conjunto con un "referenteObjectType" de "PROPIETARIO". De lo contrario, en falso.

​
formField
boolean

Si la propiedad se puede usar en un formulario de HubSpot o no.

​
hasUniqueValue
boolean

Si el valor de la propiedad debe ser único o no. Una vez establecido, esto no se puede cambiar.

​
hidden
boolean

Si es verdadero, la propiedad no será visible y no se podrá usar en HubSpot.

Ejemplo:

false

​
hubspotDefined
boolean

Esto será verdadero para las propiedades de objeto predeterminadas integradas en HubSpot.

​
modificationMetadata
object
​
referencedObjectType
string

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.

​
sensitiveDataCategories
string[]

Cuando sensitiveData es verdadero, enumera el tipo de datos sensibles contenidos en la propiedad (por ejemplo, "HIPAA").

​
showCurrencySymbol
boolean

Si la propiedad mostrará o no el símbolo de divisa en la configuración de la cuenta.

​
updatedAt
string<date-time>

La marca de tiempo en la que se actualizó la propiedad, en formato ISO 8601.

​
updatedUserId
string

El ID interno del usuario que creó la propiedad en HubSpot. Este campo puede no existir si la propiedad se actualizó fuera de HubSpot.

Last modified on March 19, 2026