Skip to main content
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.
To stop a running journey without losing its data, archive it instead: send 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’s id from the View journeys API or in the dashboard URL.

Response

A successful request returns 200 OK with a confirmation body:

Error responses

Coded errors use the shape { "errors": [{ "code", "title", "meta" }] }.

Headers

Authorization
string
default:Key YOUR_APP_API_KEY
required

Your App API key with prefix Key. See Keys & IDs.

Path Parameters

app_id
string
default:YOUR_APP_ID
required

Your OneSignal App ID in UUID v4 format. See Keys & IDs.

id
string
default:YOUR_JOURNEY_ID
required

UUID of the journey to delete.

Response

200

success
boolean

true when the journey was deleted.