Delete segment

Delete segments from OneSignal. Does not delete users or subscriptions.

delete/apps/{app_id}/segments/{segment_id}

Request

  • Base URL
    https://api.onesignal.com
  • URL
    https://api.onesignal.com/apps/{app_id}/segments/{segment_id}
  • Auth
    none required

Path parameters

app_idstring required

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

segment_idstring required

The segment's unique identifier. In the dashboard, go to Audience > Segments, open the segment's options menu, and select Copy segment ID. You can also get it from the View segments API or the segment's URL in the dashboard.

Headers

Authorizationstring required

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

Response

200

successboolean

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 2 revisions of this API.