Delete Custom Event

Deletes a custom event. The event is identified by its name.

Before you call

  • Enterprise Analytics must be turned on for your organization. If it isn't, the call fails with 403; contact Support.
  • The API key's user needs the Manage Custom Events permission, otherwise the call fails with 401.
  • name is required (3–100 characters). Any other field fails with 400.
  • Send name in the JSON request body. Some HTTP clients drop the body on DELETE requests; make sure yours sends it.

How it works

  • The event is found by its name, without regard to case, among your organization's live events. Returns 404 if no event matches.
  • An event that is used by a bot can't be deleted; the call fails with 409. extraData.botNames lists the bots that use it; remove it from those bots first.
  • Deleted events are removed from the custom events list in settings and can no longer be fired with Fire Custom Event.
  • The call returns { "success": true }.

Rate limit

  • 60 requests per minute.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 3 and 100

Name of the custom event to delete. Matched without regard to case.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json