POST
/
events
/
v3
/
event-definitions
/
{eventName}
/
property
Criar uma propriedade para uma definição de evento
curl --request POST \
  --url https://api.hubapi.com/events/v3/event-definitions/{eventName}/property \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "options": [
    {
      "hidden": true,
      "displayOrder": 123,
      "description": "<string>",
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "description": "<string>",
  "label": "<string>",
  "type": "<string>"
}'
{
  "hidden": false,
  "displayOrder": 123,
  "description": "",
  "showCurrencySymbol": false,
  "type": "",
  "hubspotDefined": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "archived": false,
  "options": "",
  "hasUniqueValue": false,
  "calculated": false,
  "externalOptions": false,
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdUserId": "",
  "modificationMetadata": {
    "readOnlyOptions": true,
    "readOnlyValue": true,
    "readOnlyDefinition": true,
    "archivable": true
  },
  "sensitiveDataCategories": "",
  "label": "",
  "formField": false,
  "dataSensitivity": "",
  "archivedAt": "2023-11-07T05:31:56Z",
  "groupName": "",
  "referencedObjectType": "",
  "name": "",
  "calculationFormula": "",
  "fieldType": "",
  "updatedUserId": "<string>"
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubEnterprise
Sales HubSales HubEnterprise
Service HubService HubEnterprise
Content HubContent HubEnterprise

Escopos Necessários

Esta API requer um dos seguintes escopos:
  • behavioral_events.event_definitions.read_write

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

eventName
string
required

O nome interno do evento personalizado.

Body

application/json

Response

201
application/json

successful operation

A HubSpot property