API Reference

Update Event

PATCH /events/:id — update a custom event definition's payload schema.

PATCH/events/:id

Updates a custom event definition's payload schema in place. The event name is immutable — renaming it would silently detach every automation whose trigger or wait step references it, so create a new event instead. Pass schema as a flat key → type map (string | number | boolean | date), or null to clear validation.

Path parameters

idstringrequired

The ID of the event definition to update.

Body parameters

schemaobject | nulloptional

The replacement payload schema (flat key→type map), or null to remove validation. Passing name is rejected with 422 validation_error.

Request

import { MailBlastr } from 'mailblastr';

const mb = new MailBlastr('mb_xxxxxxxxx');

const { data, error } = await mb.events.update('b6d24b8e-af0b-4c3c-be0c-359bbd97381e', {
  "schema": { "plan": "string", "seats": "number" }
});
console.log({ data, error });

Response

{
  "object": "event",
  "id": "b6d24b8e-af0b-4c3c-be0c-359bbd97381e",
  "name": "user.created",
  "schema": { "plan": "string", "seats": "number" },
  "created_at": "2026-06-23T10:00:00.000Z",
  "updated_at": "2026-06-24T09:00:00.000Z"
}

An unknown id returns 404 not_found; sending name or an invalid schema returns 422 validation_error. See Errors.