> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.fr/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Create an event property

> Créer une nouvelle propriété pour une définition d'événement existante.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/2026-03/events-manage-event-definitions-v2026-03.json POST /events/2026-03/event-definitions/{eventName}/property
openapi: 3.0.1
info:
  title: Events Manage Event Definitions
  description: Basepom for all HubSpot Projects
  version: 2026-03
  x-hubspot-product-tier-requirements:
    marketing: ENTERPRISE
    sales: ENTERPRISE
    service: ENTERPRISE
    cms: ENTERPRISE
    commerce: ENTERPRISE
    crmHub: ENTERPRISE
    dataHub: ENTERPRISE
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Advanced
  - name: Basic
  - name: Batch
paths:
  /events/2026-03/event-definitions/{eventName}/property:
    post:
      tags:
        - Advanced
      summary: Créer une propriété pour une définition d'événement
      description: Créer une nouvelle propriété pour une définition d'événement existante.
      operationId: post-/events/2026-03/event-definitions/{eventName}/property
      parameters:
        - name: eventName
          in: path
          description: Le nom unique de l'événement pour lequel la propriété est créée.
          required: true
          style: simple
          explode: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalBehavioralEventPropertyCreate'
        required: true
      responses:
        '201':
          description: successful operation
          headers:
            Location:
              description: URL of the newly created resource
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Property'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - behavioral_events.event_definitions.read_write
components:
  schemas:
    ExternalBehavioralEventPropertyCreate:
      required:
        - label
        - type
      type: object
      properties:
        description:
          type: string
          description: >-
            Une description de la propriété qui sera affichée comme texte d'aide
            dans HubSpot.
        label:
          type: string
          description: >-
            Libellé lisible par la personne pour la propriété. Utilisé dans l'IU
            de HubSpot
        name:
          type: string
          description: >-
            Nom interne de la propriété, qui doit être utilisé lorsque la
            propriété est référencée depuis l'API
        options:
          type: array
          description: "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."
          items:
            $ref: '#/components/schemas/OptionInput'
        type:
          type: string
          description: "Le type de données de la propriété. Peut être l'un des suivants\_: [chaîne, nombre, énumération, date et heure]"
    Property:
      required:
        - description
        - fieldType
        - groupName
        - label
        - name
        - options
        - type
      type: object
      properties:
        archived:
          type: boolean
          description: Indique si la propriété est archivée.
        archivedAt:
          type: string
          description: >-
            La date et l'heure d'archivage de cette propriété, au format ISO
            8601.
          format: date-time
        calculated:
          type: boolean
          description: Indique si la propriété est calculée.
        calculationFormula:
          type: string
          description: La formule utilisée pour calculer la propriété, le cas échéant.
        createdAt:
          type: string
          description: >-
            La date et l'heure de création de cette propriété, au format ISO
            8601.
          format: date-time
        createdUserId:
          type: string
          description: L'ID de l'utilisateur qui a créé cette propriété.
        currencyPropertyName:
          type: string
          description: Le nom de la propriété de devise associée à cette propriété.
        dataSensitivity:
          type: string
          description: "Le niveau de sensibilité des données. Les valeurs valides incluent «\_non_sensitive\_», «\_sensitive\_» et «\_highly_sensitive\_»."
          enum:
            - highly_sensitive
            - non_sensitive
            - sensitive
        dateDisplayHint:
          type: string
          description: "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\_»."
          enum:
            - absolute
            - absolute_with_relative
            - time_since
            - time_until
        description:
          type: string
          description: Une description de la propriété.
        displayOrder:
          type: integer
          description: L'ordre dans lequel cette propriété est affichée.
          format: int32
        externalOptions:
          type: boolean
          description: Indique si les options de la propriété sont externes.
        fieldType:
          type: string
          description: Le type de champ de la propriété.
        formField:
          type: boolean
          description: Indique si la propriété est un champ de formulaire.
        groupName:
          type: string
          description: Le nom du groupe auquel appartient cette propriété.
        hasUniqueValue:
          type: boolean
          description: Indique si la propriété a une valeur unique.
        hidden:
          type: boolean
          description: Indique si la propriété est masquée.
          example: false
        hubspotDefined:
          type: boolean
          description: Indique si la propriété est définie par HubSpot.
        label:
          type: string
          description: Le libellé d'affichage de la propriété.
        modificationMetadata:
          $ref: '#/components/schemas/PropertyModificationMetadata'
        name:
          type: string
          description: Le nom unique de la propriété.
        numberDisplayHint:
          type: string
          description: "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é\_»."
          enum:
            - currency
            - duration
            - formatted
            - percentage
            - probability
            - unformatted
        options:
          type: array
          description: >-
            Un ensemble d'options disponibles pour cette propriété, chacune
            définie par une étiquette, une valeur et d'autres attributs.
          items:
            $ref: '#/components/schemas/Option'
        referencedObjectType:
          type: string
          description: Le type d'objet auquel cette propriété fait référence.
        sensitiveDataCategories:
          type: array
          description: >-
            Un tableau de catégories indiquant la sensibilité des données
            contenues dans la propriété.
          items:
            type: string
        showCurrencySymbol:
          type: boolean
          description: Indique si un symbole monétaire est affiché pour la propriété.
        textDisplayHint:
          type: string
          description: "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\_»."
          enum:
            - domain_name
            - email
            - ip_address
            - multi_line
            - phone_number
            - physical_address
            - postal_code
            - unformatted_single_line
        type:
          type: string
          description: Le type de données de la propriété.
        updatedAt:
          type: string
          description: >-
            La date et l'heure de la dernière mise à jour de cette propriété, au
            format ISO 8601.
          format: date-time
        updatedUserId:
          type: string
          description: L'ID de l'utilisateur qui a mis à jour cette propriété en dernier.
      description: A HubSpot property
    OptionInput:
      required:
        - displayOrder
        - hidden
        - label
        - value
      type: object
      properties:
        description:
          type: string
          description: Une description de l'option, représentée sous forme de chaîne.
        displayOrder:
          type: integer
          description: Un entier indiquant l'ordre dans lequel l'option doit être affichée.
          format: int32
        hidden:
          type: boolean
          description: Un booléen indiquant si l'option est masquée.
        label:
          type: string
          description: Le libellé de l'option, représenté sous forme de chaîne.
        value:
          type: string
          description: La valeur associée à l'option, représentée sous forme de chaîne.
    PropertyModificationMetadata:
      required:
        - archivable
        - readOnlyDefinition
        - readOnlyValue
      type: object
      properties:
        archivable:
          type: boolean
          description: Un booléen indiquant si la propriété peut être archivée.
        readOnlyDefinition:
          type: boolean
          description: Un booléen indiquant si la propriété est en lecture seule.
        readOnlyOptions:
          type: boolean
          description: >-
            Un booléen indiquant si les options de la propriété sont en lecture
            seule.
        readOnlyValue:
          type: boolean
          description: >-
            Un booléen indiquant si la valeur de la propriété est en lecture
            seule.
    Option:
      required:
        - hidden
        - label
        - value
      type: object
      properties:
        description:
          type: string
          description: Une chaîne fournissant une description de l'option.
        displayOrder:
          type: integer
          description: >-
            Un entier indiquant l'ordre dans lequel l'option doit être affichée
            par rapport aux autres options.
          format: int32
        hidden:
          type: boolean
          description: >-
            Un booléen indiquant si l'option est masquée de l'interface
            utilisateur.
        label:
          type: string
          description: Une chaîne représentant le libellé d'affichage de l'option.
        value:
          type: string
          description: Une chaîne représentant la valeur interne de l'option.
      description: A HubSpot property option
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: La catégorie d'erreur
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexte concernant la condition d'erreur
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Un identifiant unique pour la demande. Incluez cette valeur dans
            tous les rapports d'erreurs ou tickets d'assistance
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: informations supplémentaires à propos de l'erreur
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Une carte des noms de liens vers les URI associés contenant de la
            documentation sur l'erreur ou les mesures correctives recommandées
        message:
          type: string
          description: >-
            Un message lisible par la personne décrivant l'erreur ainsi que les
            mesures correctives possibles, le cas échéant
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Une catégorie spécifique qui contient des détails plus précis sur
            l'erreur
      description: >-
        Représente une réponse d'erreur renvoyée par l'API lorsqu'une opération
        échoue. Ce composant est utilisé dans divers points de terminaison pour
        fournir des informations détaillées sur l'erreur rencontrée.
      example:
        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
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: Le code du statut associé au détail de l'erreur
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexte concernant la condition d'erreur
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: Le nom du champ ou du paramètre dans lequel l'erreur a été trouvée.
        message:
          type: string
          description: >-
            Un message lisible par la personne décrivant l'erreur ainsi que les
            mesures correctives possibles, le cas échéant
        subCategory:
          type: string
          description: >-
            Une catégorie spécifique qui contient des détails plus précis sur
            l'erreur
      description: >-
        Représente des informations détaillées sur une erreur survenue dans
        l'API. Ce composant est utilisé pour fournir un contexte et des
        spécificités supplémentaires sur les erreurs, généralement dans le cadre
        d'une réponse d'erreur.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            analytics.behavioral_events.send: ''
            behavioral_events.event_definitions.read_write: ''

````