Delete journey
Delete journey
Permanently delete a journey by its UUID. Deletion cannot be undone; archive a running journey instead if you need to keep its data.
DELETE
Delete journey
Beta. The Journeys API is in beta. Endpoints and response fields can still change.
Overview
Permanently delete a Journey by its UUID.Deletion is permanent and cannot be undone. It removes the journey and all associated data: stats, message reports, and audience activity data are lost, and users in flight stop progressing through it.
state: "archived" with Update journey. Archiving halts all user progress. An archived journey can still be read through View journey, but it cannot resume sending or be edited. See Managing Journeys for the dashboard equivalent.
How to use this API
Authenticate with your App API Key. The authenticated key must have permission to delete journeys. Find a journey’sid from the View journeys API or in the dashboard URL.
Response
A successful request returns200 OK with a confirmation body:
Error responses
Coded errors use the shape
{ "errors": [{ "code", "title", "meta" }] }.Headers
Your App API key with prefix Key. See Keys & IDs.
Path Parameters
Your OneSignal App ID in UUID v4 format. See Keys & IDs.
UUID of the journey to delete.
Response
200
true when the journey was deleted.