PATCH /projects/{project_id}/custom_events/{event_id}

Update a Custom Event

Servers

Path parameters

Name Type Required Description
project_id Integer Yes

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

event_id Integer Yes

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

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
category String No

Valid values:

  • "subscribe"
  • "search"
  • "convert"
  • "save"
  • "add_to_cart"
  • "other"
  • "purchase"
  • "share"
  • "sign_up"
name String No

A human readable name for this Event

archived Boolean No

Whether or not to archive this Event

description String No

A description of this Event

key String No

Unique string identifier for this Event within the Project

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.