Passer au contenu principal
POST
/
events
/
v3
/
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/v3/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>"
    }
  ]
}
'
{
  "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>",
  "dataSensitivity": "highly_sensitive",
  "displayOrder": 123,
  "externalOptions": true,
  "formField": true,
  "hasUniqueValue": true,
  "hidden": false,
  "hubspotDefined": true,
  "modificationMetadata": {
    "archivable": true,
    "readOnlyDefinition": true,
    "readOnlyValue": true,
    "readOnlyOptions": true
  },
  "referencedObjectType": "<string>",
  "sensitiveDataCategories": [
    "<string>"
  ],
  "showCurrencySymbol": true,
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedUserId": "<string>"
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Entreprise
Sales HubSales Hub -Entreprise
Service HubService Hub -Entreprise
Content HubContent Hub -Entreprise

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 interne de l'événement personnalisé.

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é s'il s'agit d'une énumération. NOTE : ce champ ne s'applique qu'aux propriétés énumérées.

Réponse

successful operation

A HubSpot property

​
description
string
requis

A summary of the property's purpose.

​
fieldType
string
requis

Determines how the property will appear in HubSpot's UI or on a form. Learn more in the properties API guide.

​
groupName
string
requis

The name of the group to which the property is assigned.

​
label
string
requis

The display label for the property.

​
name
string
requis

The internal name for the property.

​
options
object[]
requis

A list of valid options for the property. This field is required for enumerated properties.

​
type
string
requis

The data type of the property, such as string or number.

​
archived
boolean

Whether the property is archived.

​
archivedAt
string<date-time>

The timestamp when the property was archived, in ISO 8601 format.

​
calculated
boolean

Whether the property is a calculated field.

​
calculationFormula
string

The formula used for calculated properties.

​
createdAt
string<date-time>

The timestamp when the property was created, in ISO 8601 format.

​
createdUserId
string

The ID of the user who created the property.

​
dataSensitivity
enum<string>

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

Options disponibles:
highly_sensitive,
non_sensitive,
sensitive
​
displayOrder
integer<int32>

The position of the item relative to others in the list.

​
externalOptions
boolean

Applicable only for enumeration type properties. Should be set to true with a 'referencedObjectType' of 'OWNER'. Otherwise false.

​
formField
boolean

Whether the property can appear on forms.

​
hasUniqueValue
boolean

Whether the property is a unique identifier property.

​
hidden
boolean

Whether or not the property will be hidden from the HubSpot UI. It's recommended that this be set to false for custom properties.

Exemple:

false

​
hubspotDefined
boolean

A boolean value set to true for HubSpot default properties.

​
modificationMetadata
object
​
referencedObjectType
string

Deprecated. Use externalOptionsReferenceType instead.

​
sensitiveDataCategories
string[]

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

​
showCurrencySymbol
boolean

Whether to show the currency symbol in HubSpot's UI.

​
updatedAt
string<date-time>

The timestamp when the property was last updated, in ISO 8601 format.

​
updatedUserId
string
Last modified on December 8, 2025