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

# Create an event property

> Crie uma nova propriedade para uma definição de evento existente.

> **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: Criar uma propriedade para uma definição de evento
      description: Crie uma nova propriedade para uma definição de evento existente.
      operationId: post-/events/2026-03/event-definitions/{eventName}/property
      parameters:
        - name: eventName
          in: path
          description: >-
            O nome exclusivo do evento para o qual a propriedade está sendo
            criada.
          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: >-
            Uma descrição da propriedade que será exibida como texto de ajuda no
            HubSpot.
        label:
          type: string
          description: >-
            Rótulo legível por humanos para a propriedade. Usado na interface do
            HubSpot
        name:
          type: string
          description: >-
            Nome interno da propriedade, que deve ser usado ao referenciar a
            propriedade pela API.
        options:
          type: array
          description: >-
            Uma lista de opções disponíveis para a propriedade se for uma
            enumeração. OBSERVAÇÃO: este campo se aplica apenas a propriedades
            enumeradas.
          items:
            $ref: '#/components/schemas/OptionInput'
        type:
          type: string
          description: >-
            O tipo de dados da propriedade. Pode ser um dos seguintes: [string,
            número, enumeração, data e hora]
    Property:
      required:
        - description
        - fieldType
        - groupName
        - label
        - name
        - options
        - type
      type: object
      properties:
        archived:
          type: boolean
          description: Indica se a propriedade está arquivada.
        archivedAt:
          type: string
          description: >-
            A data e hora em que esta propriedade foi arquivada, no formato ISO
            8601.
          format: date-time
        calculated:
          type: boolean
          description: Indica se a propriedade é calculada.
        calculationFormula:
          type: string
          description: A fórmula usada para calcular a propriedade, se aplicável.
        createdAt:
          type: string
          description: >-
            A data e a hora em que esta propriedade foi criada, no formato ISO
            8601.
          format: date-time
        createdUserId:
          type: string
          description: O ID do usuário que criou esta propriedade.
        currencyPropertyName:
          type: string
          description: O nome da propriedade de moeda associada a esta propriedade.
        dataSensitivity:
          type: string
          description: >-
            O nível de confidencialidade dos dados. Os valores válidos incluem
            "non_sensitive", "sensitive" e "highly_sensitive".
          enum:
            - highly_sensitive
            - non_sensitive
            - sensitive
        dateDisplayHint:
          type: string
          description: >-
            Uma dica de como os valores de data devem ser exibidos. Os valores
            válidos incluem 'absolute', 'absolute_with_relative', 'time_since' e
            'time_until'.
          enum:
            - absolute
            - absolute_with_relative
            - time_since
            - time_until
        description:
          type: string
          description: Uma descrição da propriedade.
        displayOrder:
          type: integer
          description: A ordem em que esta propriedade é exibida.
          format: int32
        externalOptions:
          type: boolean
          description: Indica se as opções da propriedade são externas.
        fieldType:
          type: string
          description: O tipo de campo da propriedade.
        formField:
          type: boolean
          description: Indica se a propriedade é um campo de formulário.
        groupName:
          type: string
          description: O nome do grupo ao qual esta propriedade pertence.
        hasUniqueValue:
          type: boolean
          description: Indica se a propriedade tem um valor exclusivo.
        hidden:
          type: boolean
          description: Indica se a propriedade está oculta.
          example: false
        hubspotDefined:
          type: boolean
          description: Indica se a propriedade é definida pelo HubSpot.
        label:
          type: string
          description: O rótulo de exibição da propriedade.
        modificationMetadata:
          $ref: '#/components/schemas/PropertyModificationMetadata'
        name:
          type: string
          description: O nome exclusivo da propriedade.
        numberDisplayHint:
          type: string
          description: >-
            Uma dica de como os valores numéricos devem ser exibidos. Os valores
            válidos incluem "unformatted", "formatted", "currency",
            "percentage", "duration" e "probability".
          enum:
            - currency
            - duration
            - formatted
            - percentage
            - probability
            - unformatted
        options:
          type: array
          description: >-
            Uma variedade de opções disponíveis para esta propriedade, cada uma
            definida por um rótulo, valor e outros atributos.
          items:
            $ref: '#/components/schemas/Option'
        referencedObjectType:
          type: string
          description: O tipo de objeto que esta propriedade referencia.
        sensitiveDataCategories:
          type: array
          description: >-
            Uma matriz de categorias que indicam a confidencialidade dos dados
            contidos na propriedade.
          items:
            type: string
        showCurrencySymbol:
          type: boolean
          description: Indica se um símbolo de moeda é exibido para a propriedade.
        textDisplayHint:
          type: string
          description: >-
            Uma dica de como os valores de texto devem ser exibidos. Os valores
            válidos incluem 'unformatted_single_line', 'multi_line', 'email',
            'phone_number', 'domain_name', 'ip_address', 'physical_address' e
            'postal_code'.
          enum:
            - domain_name
            - email
            - ip_address
            - multi_line
            - phone_number
            - physical_address
            - postal_code
            - unformatted_single_line
        type:
          type: string
          description: O tipo de dados da propriedade.
        updatedAt:
          type: string
          description: >-
            A data e hora em que esta propriedade foi atualizada pela última
            vez, no formato ISO 8601.
          format: date-time
        updatedUserId:
          type: string
          description: O ID do usuário que atualizou esta propriedade pela última vez.
      description: A HubSpot property
    OptionInput:
      required:
        - displayOrder
        - hidden
        - label
        - value
      type: object
      properties:
        description:
          type: string
          description: Uma descrição da opção, representada como uma string.
        displayOrder:
          type: integer
          description: >-
            Um número inteiro que indica a ordem em que a opção deve ser
            exibida.
          format: int32
        hidden:
          type: boolean
          description: Um booleano que indica se a opção está oculta.
        label:
          type: string
          description: O rótulo da opção, representado como uma string.
        value:
          type: string
          description: O valor associado à opção, representado como uma string.
    PropertyModificationMetadata:
      required:
        - archivable
        - readOnlyDefinition
        - readOnlyValue
      type: object
      properties:
        archivable:
          type: boolean
          description: Um booleano que indica se a propriedade pode ser arquivada.
        readOnlyDefinition:
          type: boolean
          description: >-
            Um valor booleano que indica se a definição da propriedade é somente
            leitura.
        readOnlyOptions:
          type: boolean
          description: >-
            Um valor booleano que indica se as opções da propriedade são somente
            leitura.
        readOnlyValue:
          type: boolean
          description: >-
            Um valor booleano que indica se o valor da propriedade é somente
            leitura.
    Option:
      required:
        - hidden
        - label
        - value
      type: object
      properties:
        description:
          type: string
          description: Uma string que fornece uma descrição da opção.
        displayOrder:
          type: integer
          description: >-
            Um número inteiro que indica a ordem em que a opção deve ser exibida
            em relação a outras opções.
          format: int32
        hidden:
          type: boolean
          description: >-
            Um booleano que indica se a opção está oculta da interface do
            usuário.
        label:
          type: string
          description: Uma string que representa o rótulo de exibição da opção.
        value:
          type: string
          description: Uma string que representa o valor interno da opção.
      description: A HubSpot property option
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: A categoria de erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Um identificador exclusivo para a solicitação. Inclua este valor em
            relatórios de erro ou tickets de suporte
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: mais informações sobre o erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de links para URIs associados que contêm
            documentação sobre o erro ou as etapas de correção recomendadas
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa uma resposta de erro retornada pela API quando uma operação
        falha. Este componente é usado em vários endpoints para fornecer
        informações detalhadas sobre o erro encontrado.
      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: O código de status associado ao detalhe do erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: O nome do campo ou parâmetro no qual o erro foi encontrado.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa informações detalhadas sobre um erro ocorrido na API. Este
        componente é usado para fornecer contexto e detalhes adicionais sobre os
        erros, geralmente como parte de uma resposta de erro.
  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: ''

````