PATCH
/
apps
/
{app_id}
/
subscriptions
/
{subscription_id}
Update subscription
curl --request PATCH \
  --url https://api.onesignal.com/apps/{app_id}/subscriptions/{subscription_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "subscription": {
    "type": "Email",
    "token": "<string>",
    "enabled": true,
    "notification_types": 123,
    "session_time": 123,
    "session_count": 123,
    "app_version": "<string>",
    "device_model": "<string>",
    "device_os": "<string>",
    "test_type": 123,
    "sdk": "<string>",
    "rooted": true,
    "web_auth": "<string>",
    "web_p256": "<string>"
  }
}'
{}

​
Overview

Use this API to update an existing Subscription’s properties by subscription_id. This endpoint is primarily used by the OneSignal SDK to manage subscription state. Most external use cases are better served by the Update Subscription by token API, which can use the Email Address or Phone Number as the token or the Update User API, which allows for updating user-level data.
For email opt-outs, it’s recommended to use the Unsubscribe Email (with token) API instead. This avoids the need to store or manage the subscription_id.

​
How to use this API

Required: subscription_id To update a subscription, you must know the subscription_id. This is a UUID generated by OneSignal and is immutable.
  • You can retrieve a subscription ID by querying the User object.
  • See the Subscriptions guide for an explanation of how subscription IDs are generated and used.
You cannot update the type of a Subscription. If the type is incorrect:
  1. Use Delete Subscription to remove the incorrect entry.
  2. Use Create Subscription by alias to recreate the Subscription with the correct type.

Path Parameters

​
app_id
string
required

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

​
subscription_id
string
required

The unique Subscription ID in UUID v4 format generated by OneSignal. See Subscriptions.

Body

application/json
​
subscription
object

The subscription's properties.

Response

200

The Subscription updated successfully. This process is asynchronous and may take a few seconds to complete.