Sign in

v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB
Events

Update a Custom Event

Update a Custom Event

patch/projects/{project_id}/custom_events/{event_id}

Path parameters

project_idinteger required

The project ID of the Project the Custom Event is stored in

event_idinteger required

The Event ID of the Custom Event you'd like to change

Request body

archivedboolean

Whether or not to archive this Event

category'add_to_cart' | 'save' | 'search' | 'share' | 'purchase' | 'convert' | 'sign_up' | 'subscribe' | 'other'
descriptionstring

A description of this Event

keystring

Unique string identifier for this Event within the Project

namestring

A human readable name for this Event

Example request

{
  "key": "loaded_new_app",
  "name": "Loaded New App"
}

Response

Return the updated Event

archivedboolean

Whether or not to archive this Event

category'add_to_cart' | 'save' | 'search' | 'share' | 'purchase' | 'convert' | 'sign_up' | 'subscribe' | 'other'
createdstring date-time

Creation date for this Event

descriptionstring

A description of this Event

event_type'custom'

The type of this Event

idinteger

The unique identifier of the Event

is_classicboolean

Whether or not this Event is a classic Event. If true, this Event is read-only

is_editableboolean

Whether or not this Event may be edited

keystring required

Unique string identifier for this Event within the Project

namestring

A human readable name for this Event. If unspecified, defaults to the key

project_idinteger

The ID of this Event's parent Project

Example response

{
  "key": "loaded_new_app",
  "name": "Loaded New App",
  "project_id": 1000
}