Skip to content

Delete Event

Deletes a marketing event — the Delete row action on the admin Marketing → Communications → Events screen.

TIP

New here? Read the Events overview for what an event does and how its fields behave.

Operation

OperationTypePurpose
deleteAdminMarketingEventMutationDelete a marketing event

Details

  • Requires an admin Bearer token and the marketing.communications.events.delete permission.
  • Pass the event's IRI as id. Use the list query to discover valid ids.

Confirm success via the absence of errors

The delete mutation returns a success acknowledgement, not the deleted event's data — adminMarketingEvent resolves to null on the payload. Treat a response with no errors[] as a successful delete. If you need a confirmation message in the body, use the REST endpoint (DELETE /api/admin/marketing/events/{id}), which returns { "message": "Event deleted." }.

Input fields

FieldTypeRequiredNotes
idIDYesThe event's IRI

Released under the MIT License.