Send push messages through API

{app} parameter is required to select sources with subscribers. Each subscriber has relation with tag (app) where he gave permissions to receive push notifications. Each call of this API method should be done with required app GET parameter, using your {app-id} value. This is string value that can be found in SSP inside View Tag page. Or inside your site HTML code.

Send push notification

Send notification to a list of subscribers

POST /send

GET query parameters

• app [string] — Application ID (can be found in SSP)

Request body (JSON)

• limit [integer] — Maximum recipients amount limit (applied after filtering by targeting)
  Example: "limit": 3
• message [object] — Push message content
• icon [string] — Url of a small image that is displayed in push message. Should be https://
  Example: "icon": "https://docs.notix.co/example-icon.png"
• image [string] — Url of a big image that is displayed in push message. Displaying of this image depends on the user device. Should be https://
  Example: "image": "https://docs.notix.co/example-image.png"
• inapp_event [string] — Message inapp event. (only available for InApp)
  Example: "inapp_event": "main"
• languages [object] — Message text in different languages
• text [string] — Additional message text that is displayed after the title
  Example: "text": "We wish you a merry christmas and happy new year"
• title [string] — Message title
  Example: "title": "Merry christmas"
• url [string] — Target Url where user will be redirected after clicking on the push message
  Example: "url": "https://docs.notix.co"
• wp_guid [string]
• rules [object] — Rules of behavior when clicking on a message
• audience_exclude [boolean]
• audience_name [string]
• schedule [object] — Send push message not now and once, but in future and/or repeatable
• interval [integer] — Mailing repeat interval. Set in minutes. Minimum value: 1 hour (i.e. 60 minutes). Maximum value: 30 days (i.e 43200 minutes).
  Example: "interval": 60
• start_date [string] — Date and time when sending should be started (by default it would start immediately). Format YYYY-MM-DD hh:mm:ss in UTC timezone.
  Example: "start_date": "2022-12-25 15:04:05"
  Format: YYYY-MM-DD hh:mm:ss
• scheduled_date [string]
  Example: "scheduled_date": "2022-12-25 15:04:05"
  Format: YYYY-MM-DD hh:mm:ss
• target [object] — Filter recipients targeting
• audience [array]
• audience_exclude [boolean]
• browser [array]
• browser_exclude [boolean]
• city [array]
• city_exclude [boolean]
• device [array]
• device_exclude [boolean]
• geo [array]
• geo_exclude [boolean]
• gmt_offset [array]
• gmt_offset_exclude [boolean]
• language [array]
• language_exclude [boolean]
• last_activity_hours [object]
• hours_max [integer]
• hours_min [integer]
• last_activity_hours_exclude [boolean]
• last_click_hours [object]
• hours_max [integer]
• hours_min [integer]
• last_click_hours_exclude [boolean]
• os [array]
• os_exclude [boolean]
• os_type [array]
• os_type_exclude [boolean]
• reg_date [object]
• date_from [string]
• date_to [string]
• reg_date_exclude [boolean]
• reg_hours [object]
• hours_max [integer]
• hours_min [integer]
• reg_hours_exclude [boolean]
• region [array]
• region_exclude [boolean]
• subscription [array]
• subscription_exclude [boolean]
• user [array] — Comma separated list of users of your app (previously synced between Notix and your app)
  Example: "user":
• user_exclude [boolean] — User list should be inverted
• user_key [array]
• user_key_exclude [boolean]
• version [string] — Semantic Versioning. (only available for InApp)
  Example: "version": "1.0.0"
• version_clause [string] — Predicates eq (equal), ne (not equal), lt (less than), le (less than or equal), ge (greater than or equal), gt (greater than). (only available for InApp)
  Example: "version_clause": "eq"
• ttl [integer] — Send no longer than TTL in minutes
  Example: "ttl": 60

Response

200

400

401

403

429

500