Skip to main content
PATCH
Updates the description and/or properties schema of an existing event definition. The eventName itself cannot be changed — to rename, create a new event and delete the old one.
When properties is provided, the supplied array fully replaces the existing property schema. Properties not included in the request will be removed.

Authorizations

string | header
required
Project API key header of the form Bearer AS_<key>.

Path Parameters

string
required
Name of the event to update.Example: "order_completed"

Body

At least one of description or properties must be provided.
string
New human-readable description for the event.
object[]
Replacement property schema. Up to 50 properties per event. See Create Event for the property object shape.

Response

Event updated successfully
boolean
Example: true
object
The updated event definition.

Error Responses

object
Returned when neither description nor properties is provided.
object