Skip to main content
PATCH
/
crm
/
v3
/
properties
/
{objectType}
/
{propertyName}
Actualizar una propiedad
curl --request PATCH \
  --url https://api.hubapi.com/crm/v3/properties/{objectType}/{propertyName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "displayOrder": 2,
  "fieldType": "select",
  "formField": true,
  "groupName": "contactinformation",
  "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 -Starter
Esta API requiere uno de los siguientes ámbitos:
crm.objects.carts.write
crm.objects.orders.write
crm.objects.users.write
crm.pipelines.orders.write
crm.schemas.appointments.write
crm.schemas.carts.write
crm.schemas.commercepayments.write
crm.schemas.companies.write
crm.schemas.contacts.write
crm.schemas.courses.write
crm.schemas.deals.write
crm.schemas.invoices.write
crm.schemas.listings.write
crm.schemas.orders.write
crm.schemas.services.write
crm.schemas.subscriptions.write
e-commerce
tickets
tickets.highly_sensitive.v2
tickets.sensitive.v2

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
objectType
string
required
​
propertyName
string
required

Body

application/json
​
groupName
string

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

Example:

"contactinformation"

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

Example:

"[{\"label\":\"Option A\",\"value\":\"A\",\"hidden\":false,\"description\":\"Choice number one\",\"displayOrder\":1},{\"label\":\"Option B\",\"value\":\"B\",\"hidden\":false,\"description\":\"Choice number two\",\"displayOrder\":2}]"

​
displayOrder
integer

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.

Example:

2

​
description
string

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

​
calculationFormula
string

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

​
label
string

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

Example:

"My Contact Property"

​
type
enum<string>

El tipo de datos de la propiedad.

Available options:
bool,
date,
datetime,
enumeration,
number,
phone_number,
string
Example:

"enumeration"

​
fieldType
enum<string>

Controla cómo aparece la propiedad en HubSpot.

Available options:
booleancheckbox,
calculation_equation,
checkbox,
date,
file,
html,
number,
phonenumber,
radio,
select,
text,
textarea
Example:

"select"

​
formField
boolean

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

Response

successful operation

A HubSpot property

​
description
string
required

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

​
type
string
required

El tipo de datos de la propiedad.

Example:

"enumeration"

​
options
object[]
required

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.

Example:

"[{\"label\":\"Option A\",\"value\":\"A\",\"hidden\":false,\"description\":\"Choice number one\",\"displayOrder\":1},{\"label\":\"Option B\",\"value\":\"B\",\"hidden\":false,\"description\":\"Choice number two\",\"displayOrder\":2}]"

​
label
string
required

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

Example:

"My Contact Property"

​
groupName
string
required

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

Example:

"contactinformation"

​
name
string
required

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

Example:

"my_contact_property"

​
fieldType
string
required

Controla cómo aparece la propiedad en HubSpot.

Example:

"select"

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

​
displayOrder
integer

Las propiedades se muestran en orden, comenzando con el valor entero positivo más bajo.

Example:

2

​
showCurrencySymbol
boolean

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

​
hubspotDefined
boolean

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

​
createdAt
string<date-time>

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

​
archived
boolean

Si la propiedad se archiva o no.

​
hasUniqueValue
boolean

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

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

​
externalOptions
boolean

Para las propiedades predeterminadas, true (verdadero) indica que las opciones se almacenan fuera de la configuración de la propiedad.

​
dateDisplayHint
enum<string>
Available options:
absolute,
absolute_with_relative,
time_since,
time_until
​
updatedAt
string<date-time>

La marca de tiempo en la que se actualizó 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.

​
modificationMetadata
object
​
sensitiveDataCategories
string[]

When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").

​
formField
boolean

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

​
dataSensitivity
enum<string>

Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".

Available options:
non_sensitive,
sensitive,
highly_sensitive
​
archivedAt
string<date-time>

Cuando se archivó la propiedad.

​
referencedObjectType
string

Si esta propiedad está relacionada con otros objetos, esos objetos se mostrarán aquí.

​
calculationFormula
string

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

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

⌘I