> ## 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 a property for an event definition > Crie uma nova propriedade para uma definição de evento existente. > **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: Criar uma propriedade para uma definição de evento description: Crie uma nova propriedade para uma definição de evento existente. 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: >- 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: Se a propriedade foi arquivada. archivedAt: type: string description: >- A data e hora em que a propriedade foi arquivada, no formato ISO 8601. format: date-time calculated: type: boolean description: Se a propriedade é um campo calculado. calculationFormula: type: string description: A fórmula usada para propriedades de cálculo. createdAt: type: string description: A data e hora em que a propriedade foi criada, no formato ISO 8601. format: date-time createdUserId: type: string description: O ID do usuário que criou a propriedade. currencyPropertyName: type: string description: O nome da propriedade de moeda relacionada. dataSensitivity: type: string description: >- Indica o nível de sensibilidade da propriedade, como "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: Um resumo da finalidade da propriedade. displayOrder: type: integer description: A posição do item em relação aos outros na lista. format: int32 externalOptions: type: boolean description: >- Aplicável apenas a propriedades do tipo enumeração. Deve ser definido como verdadeiro com um "referencedObjectType" de "PROPRIETÁRIO". Caso contrário, falso. fieldType: type: string description: >- Determina como a propriedade aparecerá na interface do HubSpot ou em um formulário. Saiba mais no guia da API de propriedades. formField: type: boolean description: Se a propriedade pode aparecer em formulários. groupName: type: string description: O nome do grupo ao qual a propriedade é atribuída. hasUniqueValue: type: boolean description: Se a propriedade é uma propriedade de identificador exclusivo. hidden: type: boolean description: >- Se a propriedade será ou não ocultada da interface do HubSpot. É recomendado definir como falso para propriedades personalizadas. example: false hubspotDefined: type: boolean description: >- Um valor booleano definido como verdadeiro para propriedades padrão do HubSpot. label: type: string description: O rótulo de exibição da propriedade. modificationMetadata: $ref: '#/components/schemas/PropertyModificationMetadata' name: type: string description: O nome interno da propriedade. numberDisplayHint: type: string description: >- Dica de como uma propriedade numérica é exibida e validada na interface do HubSpot. Pode ser: "sem formato", "formatado", "moeda", "porcentagem", "duração" ou "probabilidade". enum: - currency - duration - formatted - percentage - probability - unformatted options: type: array description: >- Uma lista de opções válidas para a propriedade. Este campo é obrigatório para propriedades enumeradas. items: $ref: '#/components/schemas/Option_1' referencedObjectType: type: string description: Obsoleto. Em vez disso, use externalOptionsReferenceType. sensitiveDataCategories: type: array description: >- Quando sensitiveData é verdadeiro, lista o tipo de dados confidenciais contidos na propriedade (por exemplo, "HIPAA"). items: type: string showCurrencySymbol: type: boolean description: Se o símbolo da moeda deve ser exibido na interface do HubSpot. textDisplayHint: type: string description: >- Dica de como o texto é exibido e validado na interface do HubSpot. Pode ser: "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: O tipo de dados da propriedade, como string ou número. updatedAt: type: string description: >- A data e hora em que a propriedade foi atualizada pela última vez, no formato ISO 8601. format: date-time updatedUserId: type: string description: Propriedade do HubSpot OptionInput: required: - displayOrder - hidden - label - value type: object properties: description: type: string description: nulo displayOrder: type: integer format: int32 hidden: type: boolean label: type: string description: nulo value: type: string description: nulo 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: 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: '' ````