Skip to main content
PATCH
Update a project event definition

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<uuid>
required

Body

application/json
name
string

Event name. Must be lowercase and may contain optional dot-separated segments. Each segment starts with a lowercase letter and may contain lowercase letters, numbers, and underscores. Maximum 128 characters. Cannot be changed after events have been recorded.

Required string length: 1 - 128
Pattern: ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
Example:

"conversation.csat_scored"

description
string | null

Human-readable description of what this event means

property_schema
object

Declared properties for this event. Values are keyed by property name.

archived
boolean

Archive or restore the definition. Archived definitions retain historical events but are hidden from new tools and workflow selectors.

Response

Definition updated

data
object
required