Create or Update OneSignal Store Settings

Creates or updates one or more OneSignal push-notification settings for the store where the partner app is installed.

This endpoint is hard-scoped to the one_signal settings namespace. The namespace is fixed server-side and cannot be changed using query parameters or request body fields. No other store settings can be created or updated through this endpoint.

The target store is resolved from the OAuth access token. There is no store ID in the URL.

Existing keys are overwritten. New keys are created.

🔑Scopes

third_one_signal_write - OneSignal Notifications

Note

This scope covers both reading and writing OneSignal settings.

Tokens issued before this scope was granted will receive 403 Forbidden until the store re-authorizes the app.

Important: Cache Regeneration on Write

Every POST request clears and regenerates all store caches, not only the OneSignal settings cache.

This is an expensive operation for the store. Use this endpoint carefully.

To reduce performance impact:

Batch all settings into a single request using the settings array.

Do not send one request per key.

Do not call this endpoint repeatedly.

Do not call this endpoint inside loops or sync jobs.

Only send a write request when a value has actually changed.

info

This endpoint only creates or updates settings under the one_signal namespace.

The namespace is fixed server-side and cannot be changed.

Do not send settings[].code. Sending it returns 422.

The store is resolved from the OAuth access token.

No store ID is required in the URL.

Changes take effect immediately after a successful write.

Store settings caches are refreshed on every successful write.

Every write is recorded in the store user-action audit log.

Encrypted values are masked in audit logs.

curl --location 'https://api.zid.sa/v1/managers/store/settings/one-signal' \ --header 'Authorization: Bearer {access_token}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "settings": [ { "key": "app_id", "value": "8a3f1c2e-4b6d-4f0a-9c1e-2d7b8e5a3f10" }, { "key": "app_key", "value": "os_v2_app_xxxxxxxx", "is_encrypted": true }, { "key": "one_signal_auth_key", "value": "os_auth_xxxxxxxx", "is_encrypted": true }, { "key": "android_package_name", "value": "com.example.store" }, { "key": "android_namespace", "value": "com.example.store" }, { "key": "android_sha256_cert_fingerprints", "value": "14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5" }, { "key": "ios_app_id", "value": "1234567890" }, { "key": "ios_bundle_id", "value": "com.example.store" }, { "key": "ios_team_id", "value": "ABCDE12345" } ] }'

{ "status": "object", "payload": [ { "id": 1024551, "code": "one_signal", "key": "app_id", "value": "8a3f1c2e-..." }, { "id": 1024552, "code": "one_signal", "key": "app_key", "value": "eyJpdiI6..." } ] }

Create or Update OneSignal Store Settings

Note

info

Request

Responses

Create or Update OneSignal Store Settings

Note#

info#

Request

Responses

Note

info