Edit Custom Event

Updates the name and/or description of a custom event. The event is identified by its current 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): the event's current name. Send at least one of newName (3–100 characters) or description (up to 1,000 characters). Any other field fails with 400.

How it works

  • The event is found by its current name, without regard to case, among your organization's live events. Returns 404 if no event matches.
  • Event names are unique within your organization, without regard to case. Sending your event's own name in a different case as newName is fine; a newName already used by another event fails with 409.
  • Fire Custom Event refers to the event by name, so after a rename, fire it with the new name.
  • The response returns the updated event.

Rate limit

  • 60 requests per minute.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
Responses

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