Delete a player (aka Subscription).

This is a Legacy API. Use Delete User or Delete Subscription instead.


Path Parameters

ParameterTypeRequiredDescription
app_idstringYesYour OneSignal App ID.
player_idstringYesThe Subscription ID to delete.

Headers

HeaderValueRequiredDescription
AuthorizationBasic YOUR_LEGACY_REST_API_KEYYesYour Legacy OneSignal API key.
Content-Typeapplication/jsonYesThe content type of the request.

Example Request

DELETE /api/v1/apps/your_app_id/users/user123 HTTP/1.1
Host: onesignal.com
Authorization: Basic YOUR_LEGACY_REST_API_KEY
Content-Type: application/json

Example Response

{
  "success": true
}

The Subscription will be deleted from the OneSignal database.