API Reference

Delete Event

DELETE /events/:id — delete a custom event definition.

DELETE/events/:id

Deletes a custom event definition. Deleting the definition removes its payload schema, so future sends of the same event name are no longer validated — it does not affect automations that trigger on the event name.

Path parameters

idstringrequired

The ID of the event definition to delete.

import { MailBlastr } from 'mailblastr';

const mb = new MailBlastr('mb_xxxxxxxxx');

const { data, error } = await mb.events.remove('b6d24b8e-af0b-4c3c-be0c-359bbd97381e');
console.log({ data, error });

Response

{
  "object": "event",
  "id": "b6d24b8e-af0b-4c3c-be0c-359bbd97381e",
  "deleted": true
}

An unknown id returns 404 not_found. See Errors.