DELETE
/
apps
/
{app_id}
/
segments
/
{segment_id}
curl --request DELETE \
  --url https://api.onesignal.com/apps/{app_id}/segments/{segment_id} \
  --header 'Authorization: <authorization>'
"{\n    \"success\": true\n}"

​
Overview

The Delete segment method is used when you want to programmatically delete a segment from within the OneSignal Dashboard UI.

Once a segment is deleted, it cannot be recovered. You will need to create a new segment with the same filters.

​
How to use this API

You can pass in the segment_id dictating which segment from our dashboard will be deleted.

The segment_id can be found using the View segments API or in the URL of the segment when viewing it in the dashboard as shown below:

Example shows segment ID

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.

​
segment_id
string
default:YOUR_SEGMENT_ID
required

The segment_id can be found in the URL of the segment when viewing it in the dashboard.

Response

200
application/json

200

The response is of type object.

DELETE
/
apps
/
{app_id}
/
segments
/
{segment_id}
curl --request DELETE \
  --url https://api.onesignal.com/apps/{app_id}/segments/{segment_id} \
  --header 'Authorization: <authorization>'
"{\n    \"success\": true\n}"

​
Overview

The Delete segment method is used when you want to programmatically delete a segment from within the OneSignal Dashboard UI.

Once a segment is deleted, it cannot be recovered. You will need to create a new segment with the same filters.

​
How to use this API

You can pass in the segment_id dictating which segment from our dashboard will be deleted.

The segment_id can be found using the View segments API or in the URL of the segment when viewing it in the dashboard as shown below:

Example shows segment ID

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.

​
segment_id
string
default:YOUR_SEGMENT_ID
required

The segment_id can be found in the URL of the segment when viewing it in the dashboard.

Response

200
application/json

200

The response is of type object.