--- title: "Update a custom event definition" method: PATCH path: "/events/2026-03/event-definitions/{eventName}" tags: ["Basic"] --- # Update a custom event definition `PATCH /events/2026-03/event-definitions/{eventName}` Update a specific custom event definition by name. ## Path parameters - `eventName` string, required ## Request body - EventsDefinitionsExternalBehavioralEventTypeDefinitionPatch - `description` string — A description of the event that will be shown as help text in HubSpot. - `label` string — Human readable label for the event. Used in HubSpot UI ## Response `201` successful operation - EventsDefinitionsExternalBehavioralEventTypeDefinition - `archived` boolean, required - `associations` EventsDefinitionsAssociationDefinition[], required - `allowsCustomLabels` boolean, required — Whether custom labels can be used in the association. - `cardinality` 'ONE_TO_MANY' | 'ONE_TO_ONE', required — The cardinality from the source object's perspective, either "ONE_TO_ONE" or "ONE_TO_MANY". - `category` 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK', required — The error category - `fromObjectType` 'ABANDONED_CART' | 'ACCEPTANCE_TEST' | 'AD' | 'AD_ACCOUNT' | 'AD_CAMPAIGN' | 'AD_GROUP' | 'AI_FORECAST' | 'ALL_PAGES' | 'APPROVAL' | 'APPROVAL_STEP' | 'ATTRIBUTION' | 'AUDIENCE' | 'AUTOMATION_JOURNEY' | 'AUTOMATION_PLATFORM_FLOW' | 'AUTOMATION_PLATFORM_FLOW_ACTION' | 'BET_ALERT' | 'BET_DELIVERABLE_SERVICE' | 'BLOG_LISTING_PAGE' | 'BLOG_POST' | 'CALL' | 'CAMPAIGN' | 'CAMPAIGN_BUDGET_ITEM' | 'CAMPAIGN_SPEND_ITEM' | 'CAMPAIGN_STEP' | 'CAMPAIGN_TEMPLATE' | 'CAMPAIGN_TEMPLATE_STEP' | 'CART' | 'CASE_STUDY' | 'CHATFLOW' | 'CLIP' | 'CMS_URL' | 'COMBO_EVENT_CONFIGURATION' | 'COMMERCE_PAYMENT' | 'COMMUNICATION' | 'COMPANY' | 'CONTACT' | 'CONTACT_CREATE_ATTRIBUTION' | 'CONTENT' | 'CONTENT_AUDIT' | 'CONTENT_AUDIT_PAGE' | 'CONVERSATION' | 'CONVERSATION_INBOX' | 'CONVERSATION_SESSION' | 'CRM_OBJECTS_DUMMY_TYPE' | 'CRM_PIPELINES_DUMMY_TYPE' | 'CTA' | 'CTA_VARIANT' | 'DATA_PRIVACY_CONSENT' | 'DATA_SYNC_STATE' | 'DEAL' | 'DEAL_CREATE_ATTRIBUTION' | 'DEAL_REGISTRATION' | 'DEAL_SPLIT' | 'DISCOUNT' | 'DISCOUNT_CODE' | 'DISCOUNT_TEMPLATE' | 'EMAIL' | 'ENGAGEMENT' | 'EXPORT' | 'EXTERNAL_WEB_URL' | 'FEE' | 'FEEDBACK_SUBMISSION' | 'FEEDBACK_SURVEY' | 'FILE_MANAGER_FILE' | 'FILE_MANAGER_FOLDER' | 'FOLDER' | 'FORECAST' | 'FORM' | 'FORM_SUBMISSION_INBOUNDDB' | 'GOAL_TARGET' | 'GOAL_TARGET_GROUP' | 'GOAL_TEMPLATE' | 'GSC_PROPERTY' | 'HUB' | 'IMPORT' | 'INVOICE' | 'KEYWORD' | 'KNOWLEDGE_ARTICLE' | 'LANDING_PAGE' | 'LEAD' | 'LINE_ITEM' | 'MARKETING_CALENDAR' | 'MARKETING_CAMPAIGN_UTM' | 'MARKETING_EMAIL' | 'MARKETING_EVENT' | 'MARKETING_EVENT_ATTENDANCE' | 'MARKETING_SMS' | 'MEDIA_BRIDGE' | 'MEETING_EVENT' | 'MIC' | 'NOTE' | 'OBJECT_LIST' | 'ORDER' | 'OWNER' | 'PARTNER_ACCOUNT' | 'PARTNER_CLIENT' | 'PARTNER_CLIENT_REVENUE' | 'PARTNER_SERVICE' | 'PAYMENT_LINK' | 'PAYMENT_SCHEDULE' | 'PAYMENT_SCHEDULE_INSTALLMENT' | 'PERMISSIONS_TESTING' | 'PLAYBOOK' | 'PLAYBOOK_QUESTION' | 'PLAYBOOK_SUBMISSION' | 'PLAYBOOK_SUBMISSION_ANSWER' | 'PLAYLIST' | 'PLAYLIST_FOLDER' | 'PODCAST_EPISODE' | 'PORTAL' | 'PORTAL_OBJECT_SYNC_MESSAGE' | 'POSTAL_MAIL' | 'PRIVACY_SCANNER_COOKIE' | 'PRODUCT' | 'PRODUCT_OR_FOLDER' | 'PROPERTY_INFO' | 'PROSPECTING_AGENT_CONTACT_ASSIGNMENT' | 'PUBLISHING_TASK' | 'QUARANTINED_SUBMISSION' | 'QUOTA' | 'QUOTE' | 'QUOTE_FIELD' | 'QUOTE_MODULE' | 'QUOTE_MODULE_FIELD' | 'QUOTE_TEMPLATE' | 'RESTORABLE_CRM_OBJECT' | 'ROSTER' | 'ROSTER_MEMBER' | 'SALES_DOCUMENT' | 'SALES_TASK' | 'SALES_WORKLOAD' | 'SALESFORCE_SYNC_ERROR' | 'SCHEDULING_PAGE' | 'SCHEMAS_BACKEND_TEST' | 'SCORE_CONFIGURATION' | 'SEQUENCE' | 'SEQUENCE_ENROLLMENT' | 'SEQUENCE_STEP' | 'SEQUENCE_STEP_ENROLLMENT' | 'SERVICE' | 'SITE_PAGE' | 'SNIPPET' | 'SOCIAL_BROADCAST' | 'SOCIAL_CHANNEL' | 'SOCIAL_POST' | 'SOCIAL_PROFILE' | 'SOX_PROTECTED_DUMMY_TYPE' | 'SOX_PROTECTED_TEST_TYPE' | 'SUBMISSION_TAG' | 'SUBSCRIPTION' | 'TASK' | 'TASK_TEMPLATE' | 'TAX' | 'TEMPLATE' | 'TICKET' | 'UNKNOWN' | 'UNSUBSCRIBE' | 'USER' | 'VIEW' | 'VIEW_BLOCK' | 'WEB_INTERACTIVE' — The name of the source object type (e.g,. "DEAL" or "QUOTE"). - `fromObjectTypeId` string, required — The ID of the source object type (e.g., 0-1 for contacts). - `hasAllAssociatedObjects` boolean, required — Whether all potential linked objects are included in the association - `hasCascadingDeletes` boolean, required — Whether deletions in the association should cause cascading deletes to linked objects. - `hasUserEnforcedMaxFromObjectIds` boolean, required — Whether a user has set a limit for the number of source objects. - `hasUserEnforcedMaxToObjectIds` boolean, required — Whether a user has set a limit for the number of destination objects. - `hidden` boolean, required — Whether the association is hidden or not. - `hiddenReason` 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED' - `id` integer, required — The unique ID of the associated object (e.g., a contact ID). - `inverseAllowsCustomLabels` boolean, required — Whether the reverse association can also support custom labels. - `inverseCardinality` 'ONE_TO_MANY' | 'ONE_TO_ONE', required — The cardinality from the destination object's perspective, either "ONE_TO_ONE" or "ONE_TO_MANY". - `inverseHasAllAssociatedObjects` boolean, required — Whether all potential reverse linked objects are included in the association. - `inverseId` integer, required — The unique ID for the inverse side of the association. - `inverseLabel` string — The label used to describe the reverse relationship in an association. - `inverseName` string, required — The name used to describe the inverse relationship in this association - `isDefault` boolean, required - `isInversePrimary` boolean, required — Whether the inverse association is considered primary. - `isPrimary` boolean, required — Whether the association is the primary link between the entities involved. - `label` string — The label given to an association. - `maxFromObjectIds` integer, required — The maximum number of source object IDs allowed in the association. - `maxToObjectIds` integer, required — The maximum number of destination object IDs allowed in the association. - `name` string, required — For labeled association types, the internal name of the association. - `portalUniqueIdentifier` string, required — A unique across-portal ID applied to the association. - `readOnly` boolean, required - `toObjectType` 'ABANDONED_CART' | 'ACCEPTANCE_TEST' | 'AD' | 'AD_ACCOUNT' | 'AD_CAMPAIGN' | 'AD_GROUP' | 'AI_FORECAST' | 'ALL_PAGES' | 'APPROVAL' | 'APPROVAL_STEP' | 'ATTRIBUTION' | 'AUDIENCE' | 'AUTOMATION_JOURNEY' | 'AUTOMATION_PLATFORM_FLOW' | 'AUTOMATION_PLATFORM_FLOW_ACTION' | 'BET_ALERT' | 'BET_DELIVERABLE_SERVICE' | 'BLOG_LISTING_PAGE' | 'BLOG_POST' | 'CALL' | 'CAMPAIGN' | 'CAMPAIGN_BUDGET_ITEM' | 'CAMPAIGN_SPEND_ITEM' | 'CAMPAIGN_STEP' | 'CAMPAIGN_TEMPLATE' | 'CAMPAIGN_TEMPLATE_STEP' | 'CART' | 'CASE_STUDY' | 'CHATFLOW' | 'CLIP' | 'CMS_URL' | 'COMBO_EVENT_CONFIGURATION' | 'COMMERCE_PAYMENT' | 'COMMUNICATION' | 'COMPANY' | 'CONTACT' | 'CONTACT_CREATE_ATTRIBUTION' | 'CONTENT' | 'CONTENT_AUDIT' | 'CONTENT_AUDIT_PAGE' | 'CONVERSATION' | 'CONVERSATION_INBOX' | 'CONVERSATION_SESSION' | 'CRM_OBJECTS_DUMMY_TYPE' | 'CRM_PIPELINES_DUMMY_TYPE' | 'CTA' | 'CTA_VARIANT' | 'DATA_PRIVACY_CONSENT' | 'DATA_SYNC_STATE' | 'DEAL' | 'DEAL_CREATE_ATTRIBUTION' | 'DEAL_REGISTRATION' | 'DEAL_SPLIT' | 'DISCOUNT' | 'DISCOUNT_CODE' | 'DISCOUNT_TEMPLATE' | 'EMAIL' | 'ENGAGEMENT' | 'EXPORT' | 'EXTERNAL_WEB_URL' | 'FEE' | 'FEEDBACK_SUBMISSION' | 'FEEDBACK_SURVEY' | 'FILE_MANAGER_FILE' | 'FILE_MANAGER_FOLDER' | 'FOLDER' | 'FORECAST' | 'FORM' | 'FORM_SUBMISSION_INBOUNDDB' | 'GOAL_TARGET' | 'GOAL_TARGET_GROUP' | 'GOAL_TEMPLATE' | 'GSC_PROPERTY' | 'HUB' | 'IMPORT' | 'INVOICE' | 'KEYWORD' | 'KNOWLEDGE_ARTICLE' | 'LANDING_PAGE' | 'LEAD' | 'LINE_ITEM' | 'MARKETING_CALENDAR' | 'MARKETING_CAMPAIGN_UTM' | 'MARKETING_EMAIL' | 'MARKETING_EVENT' | 'MARKETING_EVENT_ATTENDANCE' | 'MARKETING_SMS' | 'MEDIA_BRIDGE' | 'MEETING_EVENT' | 'MIC' | 'NOTE' | 'OBJECT_LIST' | 'ORDER' | 'OWNER' | 'PARTNER_ACCOUNT' | 'PARTNER_CLIENT' | 'PARTNER_CLIENT_REVENUE' | 'PARTNER_SERVICE' | 'PAYMENT_LINK' | 'PAYMENT_SCHEDULE' | 'PAYMENT_SCHEDULE_INSTALLMENT' | 'PERMISSIONS_TESTING' | 'PLAYBOOK' | 'PLAYBOOK_QUESTION' | 'PLAYBOOK_SUBMISSION' | 'PLAYBOOK_SUBMISSION_ANSWER' | 'PLAYLIST' | 'PLAYLIST_FOLDER' | 'PODCAST_EPISODE' | 'PORTAL' | 'PORTAL_OBJECT_SYNC_MESSAGE' | 'POSTAL_MAIL' | 'PRIVACY_SCANNER_COOKIE' | 'PRODUCT' | 'PRODUCT_OR_FOLDER' | 'PROPERTY_INFO' | 'PROSPECTING_AGENT_CONTACT_ASSIGNMENT' | 'PUBLISHING_TASK' | 'QUARANTINED_SUBMISSION' | 'QUOTA' | 'QUOTE' | 'QUOTE_FIELD' | 'QUOTE_MODULE' | 'QUOTE_MODULE_FIELD' | 'QUOTE_TEMPLATE' | 'RESTORABLE_CRM_OBJECT' | 'ROSTER' | 'ROSTER_MEMBER' | 'SALES_DOCUMENT' | 'SALES_TASK' | 'SALES_WORKLOAD' | 'SALESFORCE_SYNC_ERROR' | 'SCHEDULING_PAGE' | 'SCHEMAS_BACKEND_TEST' | 'SCORE_CONFIGURATION' | 'SEQUENCE' | 'SEQUENCE_ENROLLMENT' | 'SEQUENCE_STEP' | 'SEQUENCE_STEP_ENROLLMENT' | 'SERVICE' | 'SITE_PAGE' | 'SNIPPET' | 'SOCIAL_BROADCAST' | 'SOCIAL_CHANNEL' | 'SOCIAL_POST' | 'SOCIAL_PROFILE' | 'SOX_PROTECTED_DUMMY_TYPE' | 'SOX_PROTECTED_TEST_TYPE' | 'SUBMISSION_TAG' | 'SUBSCRIPTION' | 'TASK' | 'TASK_TEMPLATE' | 'TAX' | 'TEMPLATE' | 'TICKET' | 'UNKNOWN' | 'UNSUBSCRIBE' | 'USER' | 'VIEW' | 'VIEW_BLOCK' | 'WEB_INTERACTIVE' — The name of the destination object type (e.g,. "DEAL" or "QUOTE"). - `toObjectTypeId` string, required — The ID of the destination object type (e.g., 0-3 for deals). - `comboEventRules` EventsDefinitionsComboEventRuleBranch - `composingRules` EventsDefinitionsComboEventRule[], required - `count` integer, required - `eventTypeId` string, required - `lookbackWindowDays` integer - `propertyFilters` EventsDefinitionsPropertyFilter[], required - `context` EventsDefinitionsPropertyFilterContext - `objectTypeId` string, required - `filterInsightsId` integer - `filterType` 'PROPERTY', required - `frameworkFilterId` integer - `operation` union, required - EventsDefinitionsBoolPropertyOperation - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `operationType` string, required - `operator` 'HAS_EVER_BEEN_EQUAL_TO' | 'HAS_NEVER_BEEN_EQUAL_TO' | 'IS_EQUAL_TO' | 'IS_NOT_EQUAL_TO', required - `operatorName` string, required - `propertyType` 'bool', required - `renderSpec` string - `value` boolean, required - EventsDefinitionsNumberPropertyOperation - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `operationType` string, required - `operator` 'HAS_EVER_BEEN_EQUAL_TO' | 'HAS_NEVER_BEEN_EQUAL_TO' | 'IS_EQUAL_TO' | 'IS_GREATER_THAN' | 'IS_GREATER_THAN_OR_EQUAL_TO' | 'IS_LESS_THAN' | 'IS_LESS_THAN_OR_EQUAL_TO' | 'IS_NOT_EQUAL_TO', required - `operatorName` string, required - `propertyType` 'number', required - `renderSpec` string - `value` number, required - EventsDefinitionsStringPropertyOperation - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `operationType` string, required - `operator` 'CONTAINS' | 'DOES_NOT_CONTAIN' | 'ENDS_WITH' | 'HAS_EVER_BEEN_EQUAL_TO' | 'HAS_EVER_CONTAINED' | 'HAS_NEVER_BEEN_EQUAL_TO' | 'HAS_NEVER_CONTAINED' | 'IS_EQUAL_TO' | 'IS_NOT_EQUAL_TO' | 'STARTS_WITH', required - `operatorName` string, required - `propertyType` 'string', required - `renderSpec` string - `value` string, required - EventsDefinitionsDateTimePropertyOperation - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `operationType` string, required - `operator` 'IS_AFTER' | 'IS_AFTER_DATE' | 'IS_BEFORE' | 'IS_BEFORE_DATE' | 'IS_EQUAL_TO', required - `operatorName` string, required - `propertyType` 'datetime', required - `renderSpec` string - `requiresTimeZoneConversion` boolean, required - `timestamp` integer, required - EventsDefinitionsRangedDatePropertyOperation - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `lowerBoundTimestamp` integer, required - `operationType` string, required - `operator` 'IS_BETWEEN' | 'IS_NOT_BETWEEN', required - `operatorName` string, required - `propertyType` 'datetime-ranged', required - `renderSpec` string - `requiresTimeZoneConversion` boolean, required - `upperBoundTimestamp` integer, required - EventsDefinitionsComparativeDatePropertyOperation - `comparisonPropertyName` string, required - `defaultComparisonValue` string - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `operationType` string, required - `operator` 'IS_AFTER' | 'IS_BEFORE', required - `operatorName` string, required - `propertyType` 'datetime-comparative', required - `renderSpec` string - EventsDefinitionsComparativeBoolPropertyOperation - `comparisonPropertyName` string, required - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `operationType` string, required - `operator` 'IS_EQUAL_TO' | 'IS_NOT_EQUAL_TO', required - `operatorName` string, required - `propertyType` 'bool-comparative', required - `renderSpec` string - EventsDefinitionsComparativeNumberPropertyOperation - `comparisonPropertyName` string, required - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `operationType` string, required - `operator` 'IS_EQUAL_TO' | 'IS_GREATER_THAN' | 'IS_GREATER_THAN_OR_EQUAL_TO' | 'IS_LESS_THAN' | 'IS_LESS_THAN_OR_EQUAL_TO' | 'IS_NOT_EQUAL_TO', required - `operatorName` string, required - `propertyType` 'number-comparative', required - `renderSpec` string - EventsDefinitionsComparativeStringPropertyOperation - `comparisonPropertyName` string, required - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `operationType` string, required - `operator` 'CONTAINS' | 'DOES_NOT_CONTAIN' | 'ENDS_WITH' | 'IS_EQUAL_TO' | 'IS_NOT_EQUAL_TO' | 'STARTS_WITH', required - `operatorName` string, required - `propertyType` 'string-comparative', required - `renderSpec` string - EventsDefinitionsComparativePropertyUpdatedOperation - `comparisonPropertyName` string, required - `defaultComparisonValue` string - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `operationType` string, required - `operator` 'IS_AFTER' | 'IS_BEFORE', required - `operatorName` string, required - `propertyType` 'property-updated-comparative', required - `renderSpec` string - EventsDefinitionsRollingDateRangePropertyOperation - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `numberOfDays` integer, required - `operationType` string, required - `operator` 'IS_LESS_THAN_X_DAYS_AGO' | 'IS_LESS_THAN_X_DAYS_FROM_NOW' | 'IS_MORE_THAN_X_DAYS_AGO' | 'IS_MORE_THAN_X_DAYS_FROM_NOW', required - `operatorName` string, required - `propertyType` 'datetime-rolling', required - `renderSpec` string - `requiresTimeZoneConversion` boolean, required - EventsDefinitionsRollingPropertyUpdatedOperation - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `numberOfDays` integer, required - `operationType` string, required - `operator` 'NOT_UPDATED_IN_LAST_X_DAYS' | 'UPDATED_IN_LAST_X_DAYS', required - `operatorName` string, required - `propertyType` 'rolling-property-updated', required - `renderSpec` string - EventsDefinitionsEnumerationPropertyOperation - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `operationType` string, required - `operator` 'CONTAINS_ALL' | 'DOES_NOT_CONTAIN_ALL' | 'HAS_EVER_BEEN_ANY_OF' | 'HAS_EVER_BEEN_EXACTLY' | 'HAS_EVER_CONTAINED_ALL' | 'HAS_NEVER_BEEN_ANY_OF' | 'HAS_NEVER_BEEN_EXACTLY' | 'HAS_NEVER_CONTAINED_ALL' | 'IS_ANY_OF' | 'IS_EXACTLY' | 'IS_NONE_OF' | 'IS_NOT_EXACTLY', required - `operatorName` string, required - `propertyType` 'enumeration', required - `renderSpec` string - `values` string[], required - EventsDefinitionsAllPropertyTypesOperation - `coalescingRefineBy` union, required - … - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `operationType` string, required - `operator` 'IS_BLANK' | 'IS_KNOWN' | 'IS_NOT_BLANK' | 'IS_UNKNOWN', required - `operatorName` string, required - `propertyType` 'alltypes', required - `pruningRefineBy` union - … - `renderSpec` string - EventsDefinitionsRangedNumberPropertyOperation - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `lowerBound` number, required - `operationType` string, required - `operator` 'IS_BETWEEN' | 'IS_NOT_BETWEEN', required - `operatorName` string, required - `propertyType` 'number-ranged', required - `renderSpec` string - `upperBound` number, required - EventsDefinitionsMultiStringPropertyOperation - `coalescingRefineBy` union, required - … - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `operationType` string, required - `operator` 'CONTAINS' | 'CONTAINS_EXACTLY' | 'DOES_NOT_CONTAIN' | 'DOES_NOT_CONTAIN_EXACTLY' | 'ENDS_WITH' | 'IS_EQUAL_TO' | 'IS_NOT_EQUAL_TO' | 'STARTS_WITH', required - `operatorName` string, required - `propertyType` 'multistring', required - `pruningRefineBy` union - … - `renderSpec` string - `values` string[], required - EventsDefinitionsDatePropertyOperation - `day` integer, required - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `month` 'APR' | 'AUG' | 'DEC' | 'FEB' | 'JAN' | 'JUL' | 'JUN' | 'MAR' | 'MAY' | 'NOV' | 'OCT' | 'SEP', required - `operationType` string, required - `operator` 'AFTER' | 'BEFORE' | 'EQUAL', required - `operatorName` string, required - `propertyType` 'date', required - `renderSpec` string - `year` integer, required - EventsDefinitionsCalendarDatePropertyOperation - `defaultValue` string - `fiscalYearStart` 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER' - `includeObjectsWithNoValueSet` boolean, required - `operationType` string, required - `operator` 'IN_LAST_TIME_UNIT' | 'IN_NEXT_TIME_UNIT' | 'IN_THIS_TIME_UNIT' | 'IN_THIS_TIME_UNIT_SO_FAR', required - `operatorName` string, required - `propertyType` 'calendar-date', required - `renderSpec` string - `timeUnit` 'DAY' | 'MONTH' | 'QUARTER' | 'WEEK' | 'YEAR', required - `timeUnitCount` integer, required - `useFiscalYear` boolean, required - EventsDefinitionsTimePointOperation - `defaultValue` string - `endpointBehavior` 'EXCLUSIVE' | 'INCLUSIVE', required - `includeObjectsWithNoValueSet` boolean, required - `operationType` string, required - `operator` 'IS_AFTER' | 'IS_BEFORE', required - `operatorName` string, required - `propertyParser` 'ANNIVERSARY' | 'ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION' | 'UPDATED_AT' | 'VALUE' | 'VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION', required - `propertyType` 'timepoint', required - `renderSpec` string - `timePoint` union, required - … - `type` string, required - EventsDefinitionsRangedTimeOperation - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `lowerBoundEndpointBehavior` 'EXCLUSIVE' | 'INCLUSIVE', required - `lowerBoundTimePoint` union, required - … - `operationType` string, required - `operator` 'IS_BETWEEN' | 'IS_NOT_BETWEEN', required - `operatorName` string, required - `propertyParser` 'ANNIVERSARY' | 'ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION' | 'UPDATED_AT' | 'VALUE' | 'VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION', required - `propertyType` 'rangedtime', required - `renderSpec` string - `type` string, required - `upperBoundEndpointBehavior` 'EXCLUSIVE' | 'INCLUSIVE', required - `upperBoundTimePoint` union, required - … - EventsDefinitionsRegexPropertyOperation - `caseSensitive` boolean, required - `defaultValue` string - `includeObjectsWithNoValueSet` boolean, required - `operationType` string, required - `operator` 'DOES_NOT_MATCH_REGEX' | 'MATCHES_REGEX', required - `operatorName` string, required - `pattern` string, required - `propertyType` 'regex', required - `renderSpec` string - `property` string, required - `operationType` 'AND' | 'OR', required - `ruleBranches` EventsDefinitionsComboEventRuleBranch[], required - `createdAt` string, date-time - `createdUserId` integer - `customMatchingId` EventsDefinitionsExternalObjectResolutionMappingResponse - `primaryObjectRule` EventsDefinitionsExternalPrimaryObjectResolutionRule, required - `eventPropertyName` string, required - `targetObjectPropertyName` string, required - `description` string - `detailTemplate` string - `fullyQualifiedName` string, required - `headerTemplate` string - `id` string, required - `labels` EventsDefinitionsBehavioralEventTypeDefinitionLabels, required - `plural` string - `singular` string, required - `name` string, required - `objectTypeId` string, required - `primaryObject` string - `primaryObjectId` string - `properties` Property[], required - `archived` boolean — Whether or not the property is archived. - `archivedAt` string, date-time — When the property was archived. - `calculated` boolean — For default properties, true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties. - `calculationFormula` string — The formula used for calculated properties. - `createdAt` string, date-time — When the property was created - `createdUserId` string — The internal ID of the user who created the property in HubSpot. This field may not exist if the property was created outside of HubSpot. - `currencyPropertyName` string — The name of the related currency property. - `dataSensitivity` 'highly_sensitive' | 'non_sensitive' | 'sensitive' — Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive". - `dateDisplayHint` 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until' — Controls how date properties are displayed in the HubSpot UI, with options such as 'absolute', 'absolute_with_relative', 'time_since', and 'time_until'. - `description` string, required — A description of the property that will be shown as help text in HubSpot. - `displayOrder` integer — The order that this property should be displayed in the HubSpot UI relative to other properties for this object type. Properties are displayed in order starting with the lowest positive integer value. A value of -1 will cause the property to be displayed **after** any positive values. - `externalOptions` boolean — For default properties, true indicates that the options are stored externally to the property settings. - `fieldType` string, required — Controls how the property appears in HubSpot. - `formField` boolean — Whether or not the property can be used in a HubSpot form. - `groupName` string, required — The name of the property group the property belongs to. - `hasUniqueValue` boolean — Whether or not the property's value must be unique. Once set, this can't be changed. - `hidden` boolean — Hidden options won't be shown in HubSpot. - `hubspotDefined` boolean — This will be true for default object properties built into HubSpot. - `label` string, required — A human-readable property label that will be shown in HubSpot. - `modificationMetadata` PropertyModificationMetadata - `archivable` boolean, required - `readOnlyDefinition` boolean, required - `readOnlyOptions` boolean - `readOnlyValue` boolean, required - `name` string, required — The internal property name, which must be used when referencing the property via the API. - `numberDisplayHint` 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted' — Hint for how a number property is displayed and validated in HubSpot's UI. Can be: "unformatted", "formatted", "currency", "percentage", "duration", or "probability". - `options` Option[], required — A list of valid options for the property. This field is required for enumerated properties, but will be empty for other property types. - `description` string — A description of the option. - `displayOrder` integer — Options are displayed in order starting with the lowest positive integer value. Values of -1 will cause the option to be displayed after any positive values. - `hidden` boolean, required — Hidden options will not be displayed in HubSpot. - `label` string, required — A human-readable option label that will be shown in HubSpot. - `value` string, required — The internal value of the option, which must be used when setting the property value through the API. - `referencedObjectType` string — If this property is related to other object(s), they'll be listed here. - `sensitiveDataCategories` string[] — When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA"). - `showCurrencySymbol` boolean — Whether the property will display the currency symbol set in the account settings. - `type` string, required — The property data type. - `updatedAt` string, date-time — When the object type was last updated. - `updatedUserId` string — The internal user ID of the user who updated the property in HubSpot. This field may not exist if the property was updated outside of HubSpot. - `trackingType` 'APP_EVENT' | 'AUTOCAPTURE_EVENT' | 'CLICKED_ELEMENT' | 'COMBO_EVENT' | 'CUSTOM_SCRIPT' | 'CUSTOM_SIGNAL' | 'IMPORT' | 'MANUAL' | 'PROPERTY_CHANGE' | 'VISITED_URL' | 'WEBHOOK' - `updatedAt` string, date-time - `updatedUserId` integer ## Other responses - `default` — An error occurred. --- [API](https://skmtc.net/hubspot/apis/hubspot-api-specification.md) · [All operations](https://skmtc.net/hubspot/apis/hubspot-api-specification/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hubspot/hubspot-api-specification/versions/f9c7181056c5/schema)