> ## 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 a property for an event definition > Créer une nouvelle propriété pour une définition d'événement existante. > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/legacy/v3/events-manage-event-definitions-v3.json POST /events/v3/event-definitions/{eventName}/property openapi: 3.0.1 info: title: Events Manage Event Definitions description: Endpoint to create, delete and get behavioral event definitions version: v3 x-hubspot-product-tier-requirements: marketing: ENTERPRISE sales: ENTERPRISE service: ENTERPRISE cms: ENTERPRISE commerce: ENTERPRISE crmHub: ENTERPRISE dataHub: ENTERPRISE x-hubspot-related-documentation: - name: Custom Events Definitions Guide url: >- https://developers.hubspot.com/docs/guides/api/analytics-and-events/custom-events/custom-event-definitions servers: - url: https://api.hubapi.com security: [] tags: - name: Advanced - name: Basic - name: Batch paths: /events/v3/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/v3/event-definitions/{eventName}/property parameters: - name: eventName in: path description: '' 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: "Date et heure d'archivage de la propriété, au format ISO\_8601." format: date-time calculated: type: boolean description: Si la propriété est un champ calculé. calculationFormula: type: string description: La formule utilisée pour les propriétés calculées. createdAt: type: string description: "Date à laquelle la propriété a été créée, au format ISO\_8601." format: date-time createdUserId: type: string description: L'ID de l'utilisateur qui a créé la propriété. currencyPropertyName: type: string description: Le nom de la propriété de la devise associée. dataSensitivity: type: string description: "Indique le niveau de sensibilité de la propriété, par exemple «\_non_sensitive\_», «\_sensitive\_» ou «\_highly_sensitive\_»." enum: - highly_sensitive - non_sensitive - sensitive dateDisplayHint: type: string enum: - absolute - absolute_with_relative - time_since - time_until description: type: string description: Un résumé de l'objectif de la propriété. displayOrder: type: integer description: >- La position de l'élément par rapport aux autres éléments de la liste. format: int32 externalOptions: type: boolean description: "Applicable uniquement aux propriétés de type «\_énumération\_». Doit être définie sur «\_true\_» avec un «\_referencedObjectType\_» de «\_OWNER\_». Sinon, définir sur «\_false\_»." fieldType: type: string description: >- Détermine comment la propriété apparaîtra dans l'interface utilisateur de HubSpot ou sur un formulaire. Pour en savoir plus, consultez le guide de l'API sur les propriétés. formField: type: boolean description: Si la propriété peut apparaître sur les formulaires. groupName: type: string description: Le nom du groupe auquel la propriété est attribuée. hasUniqueValue: type: boolean description: Indique si la propriété est une propriété à identifiant unique. hidden: type: boolean description: "Si la propriété sera masquée de l'interface utilisateur HubSpot ou non. Il est recommandé de laisser la valeur définie sur «\_faux\_» pour les propriétés personnalisées." example: false hubspotDefined: type: boolean description: >- Une valeur booléenne fixée à true pour les propriétés par défaut de HubSpot. label: type: string description: Le libellé d'affichage de la propriété. modificationMetadata: $ref: '#/components/schemas/PropertyModificationMetadata' name: type: string description: Le nom interne de la propriété. numberDisplayHint: type: string description: "Indication sur la manière dont une propriété numérique est affichée et validée dans l'interface utilisateur de HubSpot. Peut être\_: «\_non formaté\_», «\_formaté\_», «\_devise\_», «\_pourcentage\_», «\_durée\_» ou «\_probabilité\_»." enum: - currency - duration - formatted - percentage - probability - unformatted options: type: array description: >- Une liste d'options valides pour la propriété. Ce champ est requis pour les propriétés énumérées. items: $ref: '#/components/schemas/Option_1' referencedObjectType: type: string description: Obsolète. Utilisez plutôt externalOptionsReferenceType. sensitiveDataCategories: type: array description: "Lorsque sensitiveData est vrai, liste le type de données sensibles contenues dans la propriété (par exemple, «\_HIPAA\_»)." items: type: string showCurrencySymbol: type: boolean description: >- Afficher ou non le symbole de la devise dans l'interface utilisateur de HubSpot. textDisplayHint: type: string description: "Indication sur la manière dont le texte est affiché et validé dans l'interface utilisateur de HubSpot. Peut être =\_: «\_unformatted_single_line\_», «\_multi_line\_», «\_email\_», «\_phone_number\_», «\_domain_name\_», «\_ip_address\_», «\_physical_address\_» ou «\_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é, par exemple une chaîne ou un nombre. updatedAt: type: string description: "L'horodatage du moment où la propriété a été mise à jour pour la dernière fois, au format ISO\_8601." format: date-time updatedUserId: type: string description: Propriété HubSpot OptionInput: required: - displayOrder - hidden - label - value type: object properties: description: type: string description: non valide displayOrder: type: integer format: int32 hidden: type: boolean label: type: string description: non valide value: type: string description: non valide PropertyModificationMetadata: required: - archivable - readOnlyDefinition - readOnlyValue type: object properties: archivable: type: boolean readOnlyDefinition: type: boolean readOnlyOptions: type: boolean readOnlyValue: type: boolean Option_1: required: - hidden - label - value type: object properties: description: type: string displayOrder: type: integer format: int32 hidden: type: boolean label: type: string value: type: string 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: '' ````