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
    Example: "limit": 3
  • message [object] — 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"
    • 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"
  • schedule [object] — Schedule content
    • 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"
  • scheduled_date [string]
  • 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]
    • language [array]
    • language_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]
  • ttl [integer] — Send no longer than TTL in minutes
    Example: "ttl": 60

Response

HTTP STATUS REASON
200
Success
400
Wrong request body, please check request format and data types
401
Wrong or empty access token, check `Authorization-Token` request header
403
Wrong access token for this application, check both GET parameter with name `app` and `Authorization-Token` request header
500
Something went wrong on our side, we'll try to fix it ASAP