Skip to main content
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"
}
'
{
  "createdResourceId": "<string>",
  "entity": {
    "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"
  },
  "location": "<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 -Starter

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
objectType
string
required

Body

application/json
​
fieldType
enum<string>
required

Controla cómo aparece la propiedad en HubSpot.

Available options:
booleancheckbox,
calculation_equation,
checkbox,
date,
file,
html,
number,
phonenumber,
radio,
select,
text,
textarea
​
groupName
string
required

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

​
label
string
required

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

​
name
string
required

El nombre interno de la propiedad, que debe usarse al referenciar la propiedad a través de la API.

​
type
enum<string>
required

El tipo de datos de la propiedad.

Available options:
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>
Available options:
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>

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.

​
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 opción no se mostrará en formularios, bots o páginas de programación de reuniones. Compatible con las propiedades de enumeración de contactos, empresas, tickets y objetos personalizados.

​
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.

Response

successful operation

​
createdResourceId
string
required
​
entity
object
required

A HubSpot property

Example:
{
  "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"
}
​
location
string