Create an event property

Crear propiedad

curl --request POST \
  --url https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "type": "<string>",
  "description": "<string>",
  "name": "<string>",
  "options": [
    {
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  ]
}
'

import requests

url = "https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property"

payload = {
    "label": "<string>",
    "type": "<string>",
    "description": "<string>",
    "name": "<string>",
    "options": [
        {
            "displayOrder": 123,
            "hidden": True,
            "label": "<string>",
            "value": "<string>",
            "description": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    label: '<string>',
    type: '<string>',
    description: '<string>',
    name: '<string>',
    options: [
      {
        displayOrder: 123,
        hidden: true,
        label: '<string>',
        value: '<string>',
        description: '<string>'
      }
    ]
  })
};

fetch('https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'label' => '<string>',
    'type' => '<string>',
    'description' => '<string>',
    'name' => '<string>',
    'options' => [
        [
                'displayOrder' => 123,
                'hidden' => true,
                'label' => '<string>',
                'value' => '<string>',
                'description' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "description": "<string>",
  "fieldType": "<string>",
  "groupName": "<string>",
  "label": "<string>",
  "name": "<string>",
  "options": [
    {
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>",
      "displayOrder": 123
    }
  ],
  "type": "<string>",
  "archived": true,
  "archivedAt": "2023-11-07T05:31:56Z",
  "calculated": true,
  "calculationFormula": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdUserId": "<string>",
  "currencyPropertyName": "<string>",
  "dataSensitivity": "highly_sensitive",
  "dateDisplayHint": "absolute",
  "displayOrder": 123,
  "externalOptions": true,
  "formField": true,
  "hasUniqueValue": true,
  "hidden": false,
  "hubspotDefined": true,
  "modificationMetadata": {
    "archivable": true,
    "readOnlyDefinition": true,
    "readOnlyValue": true,
    "readOnlyOptions": true
  },
  "numberDisplayHint": "currency",
  "referencedObjectType": "<string>",
  "sensitiveDataCategories": [
    "<string>"
  ],
  "showCurrencySymbol": true,
  "textDisplayHint": "domain_name",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedUserId": "<string>"
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

POST

events

2026-09

event-definitions

{eventName}

property

Crear propiedad

curl --request POST \
  --url https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "type": "<string>",
  "description": "<string>",
  "name": "<string>",
  "options": [
    {
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  ]
}
'

import requests

url = "https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property"

payload = {
    "label": "<string>",
    "type": "<string>",
    "description": "<string>",
    "name": "<string>",
    "options": [
        {
            "displayOrder": 123,
            "hidden": True,
            "label": "<string>",
            "value": "<string>",
            "description": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    label: '<string>',
    type: '<string>',
    description: '<string>',
    name: '<string>',
    options: [
      {
        displayOrder: 123,
        hidden: true,
        label: '<string>',
        value: '<string>',
        description: '<string>'
      }
    ]
  })
};

fetch('https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'label' => '<string>',
    'type' => '<string>',
    'description' => '<string>',
    'name' => '<string>',
    'options' => [
        [
                'displayOrder' => 123,
                'hidden' => true,
                'label' => '<string>',
                'value' => '<string>',
                'description' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "description": "<string>",
  "fieldType": "<string>",
  "groupName": "<string>",
  "label": "<string>",
  "name": "<string>",
  "options": [
    {
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>",
      "displayOrder": 123
    }
  ],
  "type": "<string>",
  "archived": true,
  "archivedAt": "2023-11-07T05:31:56Z",
  "calculated": true,
  "calculationFormula": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdUserId": "<string>",
  "currencyPropertyName": "<string>",
  "dataSensitivity": "highly_sensitive",
  "dateDisplayHint": "absolute",
  "displayOrder": 123,
  "externalOptions": true,
  "formField": true,
  "hasUniqueValue": true,
  "hidden": false,
  "hubspotDefined": true,
  "modificationMetadata": {
    "archivable": true,
    "readOnlyDefinition": true,
    "readOnlyValue": true,
    "readOnlyOptions": true
  },
  "numberDisplayHint": "currency",
  "referencedObjectType": "<string>",
  "sensitiveDataCategories": [
    "<string>"
  ],
  "showCurrencySymbol": true,
  "textDisplayHint": "domain_name",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedUserId": "<string>"
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

Supported products

Required Scopes

Autorizaciones

Authorization

string

header

requerido

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

Parámetros de ruta

eventName

string

requerido

El identificador único de la definición del evento para el que se está creando la propiedad.

Cuerpo

application/json

label

string

requerido

Una cadena que representa el nombre visible de la propiedad. Este campo es obligatorio.

type

string

requerido

Una cadena que indica el tipo de datos de la propiedad. Este campo es obligatorio.

description

string

Una cadena que proporciona información adicional sobre la propiedad.

name

string

Una cadena que representa el nombre único de la propiedad.

options

object[]

Un conjunto de objetos OptionInput que definen los posibles valores para la propiedad.

Show child attributes

Respuesta

successful operation

A HubSpot property

description

string

requerido

Una descripción de la propiedad.

fieldType

string

requerido

El tipo de campo de la propiedad.

groupName

string

requerido

El nombre del grupo al que pertenece esta propiedad.

label

string

requerido

La etiqueta de visualización de la propiedad.

name

string

requerido

El nombre único de la propiedad.

options

object[]

requerido

Un conjunto de opciones disponibles para esta propiedad, aplicable si la propiedad admite múltiples valores.

Show child attributes

type

string

requerido

El tipo de datos de la propiedad.

archived

boolean

Indica si la propiedad está archivada.

archivedAt

string<date-time>

La fecha y hora en que se archivó esta propiedad, en formato ISO 8601.

calculated

boolean

Indica si la propiedad se calcula.

calculationFormula

string

La fórmula utilizada para calcular el valor de la propiedad, si corresponde.

createdAt

string<date-time>

La fecha y hora en que se creó esta propiedad, en formato ISO 8601.

createdUserId

string

El ID del usuario que creó esta propiedad.

currencyPropertyName

string

El nombre de la propiedad de divisa asociada a esta propiedad.

dataSensitivity

enum<string>

El nivel de sensibilidad de los datos, con valores válidos que incluyen "non_sensitive", "sensitive" y "highly_sensitive".

Opciones disponibles:

highly_sensitive,

non_sensitive,

sensitive

dateDisplayHint

enum<string>

Una sugerencia para mostrar propiedades de fecha, con valores válidos que incluyen "absolute", "absolute_with_relative", "time_since" y "time_until".

Opciones disponibles:

absolute,

absolute_with_relative,

time_since,

time_until

displayOrder

integer<int32>

El orden en que se muestra esta propiedad en relación con otras propiedades.

externalOptions

boolean

Indica si las opciones de la propiedad son externas.

formField

boolean

Indica si la propiedad es un campo de formulario.

hasUniqueValue

boolean

Indica si la propiedad tiene un valor único.

hidden

boolean

Indica si la propiedad está oculta.

Ejemplo:

false

hubspotDefined

boolean

Indica si la propiedad está definida por HubSpot.

modificationMetadata

object

Show child attributes

numberDisplayHint

enum<string>

Una sugerencia para mostrar propiedades numéricas, con valores válidos que incluyen "unformatted", "formatted", "currency", "percentage", "duration" y "probability".

Opciones disponibles:

currency,

duration,

formatted,

percentage,

probability,

unformatted

referencedObjectType

string

El tipo de objeto al que hace referencia esta propiedad.

sensitiveDataCategories

string[]

Un conjunto de categorías que indican la sensibilidad de los datos.

showCurrencySymbol

boolean

Indica si se muestra un símbolo de divisa para la propiedad.

textDisplayHint

enum<string>

Una sugerencia para mostrar las propiedades de texto, con valores válidos que incluyen "unformatted_single_line", "multi_line", "email", "phone_number", "domain_name", "ip_address", "physical_address" y "postal_code".

Opciones disponibles:

domain_name,

email,

ip_address,

multi_line,

phone_number,

physical_address,

postal_code,

unformatted_single_line

updatedAt

string<date-time>

La fecha y hora en que esta propiedad se actualizó por última vez, en formato ISO 8601.

updatedUserId

string

El ID del usuario que actualizó esta propiedad por última vez.

Última modificación el 6 de octubre de 2026

Cuenta y configuración

Gestión de aplicaciones

Autenticación

Automatización

CMS

Preferencias de comunicación

Conversaciones

CRM

Data Studio

Eventos

Archivos

Marketing

Reuniones

Ingresos

Webhooks

Registro de webhooks

Create an event property

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta