PATCH/events/{identifier}

Update an event

Updates the payload schema for an existing event. Supply schema as a flat key/type map using string, number, boolean, or date, or set it to null to clear the schema.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
identifierstringrequired
The event ID in UUID format or the event name.

The event payload schema to set, or null to clear the existing schema.

schemaobjectrequired
A flat key/type map defining the event payload schema. Set to `null` to clear the schema. Supported types are `string`, `number`, `boolean`, and `date`.

1 status code
200Returns an object containing the updated event's UUID in `id` and the response object type.
objectstringoptional
Type of the response object.
idstringoptional
The ID of the updated event.

Error handling

The schema field is required and must be a flat key/type map using string, number, boolean, or date, or null to clear the schema. The identifier path parameter must be an event UUID or event name.