Delete subscription
Delete a specific subscription by its subscription_id. This stops messages from being sent to that subscription but does not prevent future subscriptions with the same token.
Overview
Use this API to delete an existing subscription and its associated properties. Deletion is asynchronous, and while the subscription is being removed, messages will no longer be sent to it.
This operation only deletes a single subscription. To remove a user and all their subscriptions, use the Delete User API instead.
What Happens When You Delete
- Messages will stop being sent to the deleted subscription.
- Deleting a subscription does not block new subscriptions with the same
token.- If the app is reopened or a token is re-submitted (e.g., same email or phone), a new subscription may be automatically created.
- This ensures users can re-subscribe if needed without requiring manual intervention.
How to Use This API
Required: subscription_id
You must provide the subscription_id of the subscription to be deleted. This ID is a UUID generated by OneSignal and is immutable.
To find the subscription_id:
- Use the View User API.
- Look at the
subscriptionsarray in the response. - Identify the correct subscription by its
type,token, or other metadata. - Use the corresponding
idfield as thesubscription_id.
Path Parameters
Your OneSignal App ID in UUID v4 format. See Keys & IDs.
The unique Subscription ID in UUID v4 format generated by OneSignal. See Subscriptions.
Response
202
The response is of type object.