Basic

Update event definition

Changed on Oct 16, 2026

Update the definition of a specific behavioral event in your HubSpot account. This operation allows you to modify the properties and templates associated with the event. The eventName path parameter identifies the event to be updated.

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

Request

Base URL
https://api.hubapi.com
URL
https://api.hubapi.com/events/2026-09/event-definitions/{eventName}
Auth
OAuth 2
Authorization code: https://app.hubspot.com/oauth/authorize
Token URL: https://api.hubapi.com/oauth/v1/token scopes: behavioral_events.event_definitions.read_write

Path parameters

eventNamestring required

The unique name of the event definition to update.

Request body

descriptionstring

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

detailTemplatestring

The rendering template for the body of the CRM timeline activity card.

headerTemplatestring

The rendering template for the header of the CRM timeline activity card.

labelstring

Human readable label for the event. Used in HubSpot UI.

Response

successful operation

archivedboolean required

A boolean indicating whether the event type is archived.

createdAtstring date-time

A string representing the date and time when the event type was created, in ISO 8601 format.

createdUserIdinteger

An integer representing the ID of the user who created the event type.

descriptionstring

A string providing a description of the event type.

detailTemplatestring

The rendering template for the body of the CRM timeline activity card.

fullyQualifiedNamestring required

A string representing the fully qualified name of the event type.

headerTemplatestring

The rendering template for the header of the CRM timeline activity card.

idstring required

A string representing the unique identifier of the event type.

namestring required

A string representing the name of the event type.

objectTypeIdstring required

A string representing the object type ID associated with the event type.

primaryObjectstring

A string representing the primary object associated with the event type.

primaryObjectIdstring

A string representing the ID of the primary object associated with the event type.

A string indicating the tracking type of the event. Valid values include 'VISITED_URL', 'CLICKED_ELEMENT', 'CUSTOM_SCRIPT', 'MANUAL', 'IMPORT', 'PROPERTY_CHANGE', 'COMBO_EVENT'.

updatedAtstring date-time

A string representing the date and time when the event type was last updated, in ISO 8601 format.

updatedUserIdinteger

An integer representing the ID of the user who last updated the event type.

Changes

Oct 16, 20262026-09758db024626a Revision changes
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property ///////// to the response with the status
- info
  added the optional property ///////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property ///////// to the response with the status
- info
  added the optional property ///////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status

Operation history