Create an event property

Créer une propriété pour une définition d'événement

curl --request POST \
  --url https://api.hubapi.com/events/2026-03/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-03/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-03/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-03/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-03/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-03/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-03/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-03

event-definitions

{eventName}

property

Créer une propriété pour une définition d'événement

curl --request POST \
  --url https://api.hubapi.com/events/2026-03/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-03/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-03/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-03/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-03/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-03/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-03/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

Autorisations

Authorization

string

header

requis

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

Paramètres de chemin

eventName

string

requis

Le nom unique de l'événement pour lequel la propriété est créée.

Corps

application/json

label

string

requis

Libellé lisible par la personne pour la propriété. Utilisé dans l'IU de HubSpot

type

string

requis

Le type de données de la propriété. Peut être l'un des suivants : [chaîne, nombre, énumération, date et heure]

description

string

Une description de la propriété qui sera affichée comme texte d'aide dans HubSpot.

name

string

Nom interne de la propriété, qui doit être utilisé lorsque la propriété est référencée depuis l'API

options

object[]

Une liste d'options disponibles pour la propriété si elle est une énumération. NOTE : ce champ ne s'applique qu'aux propriétés énumérées.

Show child attributes

Réponse

successful operation

A HubSpot property

description

string

requis

Une description de la propriété.

fieldType

string

requis

Le type de champ de la propriété.

groupName

string

requis

Le nom du groupe auquel appartient cette propriété.

label

string

requis

Le libellé d'affichage de la propriété.

name

string

requis

Le nom unique de la propriété.

options

object[]

requis

Un ensemble d'options disponibles pour cette propriété, chacune définie par une étiquette, une valeur et d'autres attributs.

Show child attributes

type

string

requis

Le type de données de la propriété.

archived

boolean

Indique si la propriété est archivée.

archivedAt

string<date-time>

La date et l'heure d'archivage de cette propriété, au format ISO 8601.

calculated

boolean

Indique si la propriété est calculée.

calculationFormula

string

La formule utilisée pour calculer la propriété, le cas échéant.

createdAt

string<date-time>

La date et l'heure de création de cette propriété, au format ISO 8601.

createdUserId

string

L'ID de l'utilisateur qui a créé cette propriété.

currencyPropertyName

string

Le nom de la propriété de devise associée à cette propriété.

dataSensitivity

enum<string>

Le niveau de sensibilité des données. Les valeurs valides incluent « non_sensitive », « sensitive » et « highly_sensitive ».

Options disponibles:

highly_sensitive,

non_sensitive,

sensitive

dateDisplayHint

enum<string>

Une indication sur la manière dont les valeurs de date doivent être affichées. Les valeurs valides incluent « absolute », « absolute_with_relative », « time_since » et « time_until ».

Options disponibles:

absolute,

absolute_with_relative,

time_since,

time_until

displayOrder

integer<int32>

L'ordre dans lequel cette propriété est affichée.

externalOptions

boolean

Indique si les options de la propriété sont externes.

formField

boolean

Indique si la propriété est un champ de formulaire.

hasUniqueValue

boolean

Indique si la propriété a une valeur unique.

hidden

boolean

Indique si la propriété est masquée.

Exemple:

false

hubspotDefined

boolean

Indique si la propriété est définie par HubSpot.

modificationMetadata

object

Show child attributes

numberDisplayHint

enum<string>

Une indication sur la manière dont les valeurs numériques doivent être affichées. Les valeurs valides incluent « non formaté », « formaté », « devise », « pourcentage », « durée » et « probabilité ».

Options disponibles:

currency,

duration,

formatted,

percentage,

probability,

unformatted

referencedObjectType

string

Le type d'objet auquel cette propriété fait référence.

sensitiveDataCategories

string[]

Un tableau de catégories indiquant la sensibilité des données contenues dans la propriété.

showCurrencySymbol

boolean

Indique si un symbole monétaire est affiché pour la propriété.

textDisplayHint

enum<string>

Une indication sur la manière dont les valeurs de texte doivent être affichées. Les valeurs valides incluent « unformatted_single_line », « multi_line », « email », « phone_number », « domain_name », « ip_address », « physical_address » et « postal_code ».

Options disponibles:

domain_name,

email,

ip_address,

multi_line,

phone_number,

physical_address,

postal_code,

unformatted_single_line

updatedAt

string<date-time>

La date et l'heure de la dernière mise à jour de cette propriété, au format ISO 8601.

updatedUserId

string

L'ID de l'utilisateur qui a mis à jour cette propriété en dernier.

Dernière modification le 6 octobre 2026

Compte et paramètres

Gestion des applications

Authentification

Automatisation

CMS

Préférences de communication

Conversations

CRM

Événements

Fichiers

Marketing

Planificateur

Webhooks

Journal des webhooks

Create an event property

Autorisations

Paramètres de chemin

Corps

Réponse