Get Web Push Opt-in

Returns the tenant's web push opt-in prompt configuration. The opt-in prompt is the UI shown to browser visitors asking them to subscribe to push notifications. A tenant has at most one opt-in configuration.

Use Create or Update Web Push Opt-in to create or change the configuration.

HTTP Response Examples
200
{ "Status": true, "Message": "", "Response": { "optin": { "title": "Get updates from Example", "body": "We'll send you notifications for new posts and offers.", "logo": "https://cdn.example.com/logo.png", "serviceworker_url": "https://www.example.com/sw.js", "placement": 0, "date_last_modified": "2026-04-20T14:30:00" } } }
HTTP Response Parameters
optinobjectrequired
The tenant's opt-in configuration, or null if none has been saved.
optin.titlestringrequired
Title displayed on the opt-in prompt.
optin.bodystringrequired
Body text displayed on the opt-in prompt.
optin.logostring
URL of the logo shown on the opt-in prompt.
optin.serviceworker_urlstring
URL of the service worker script used to register the subscription.
optin.placementnumberrequired
Placement of the prompt. 0 = TopRight, 10 = TopLeft, 20 = TopCenter.
optin.date_last_modifiedstringrequired
ISO timestamp when the configuration was last updated.