Sign in
Basic

Update a custom event definition

Update a specific custom event definition by name.

patch/events/2026-03/event-definitions/{eventName}

Path parameters

eventNamestring required

Request body

descriptionstring

A description of the event that will be shown as help text in HubSpot.

labelstring

Human readable label for the event. Used in HubSpot UI

Response

successful operation

archivedboolean required
createdAtstring date-time
createdUserIdinteger
descriptionstring
detailTemplatestring
fullyQualifiedNamestring required
headerTemplatestring
idstring required
namestring required
objectTypeIdstring required
primaryObjectstring
primaryObjectIdstring
trackingType'APP_EVENT' | 'AUTOCAPTURE_EVENT' | 'CLICKED_ELEMENT' | 'COMBO_EVENT' | 'CUSTOM_SCRIPT' | 'CUSTOM_SIGNAL' | 'IMPORT' | 'MANUAL' | 'PROPERTY_CHANGE' | 'VISITED_URL' | 'WEBHOOK'
updatedAtstring date-time
updatedUserIdinteger

Changes

Changed in 1 of the 14 revisions of this API.1

Of the 14 revisions, 1 has no diff computed and 2 have a changelog that could not be searched.