Manage existing subscribers audiences

Notix API allows to manage user audiences (segments, tags). You can use it for separating some groups of your subscribers and using them later for sending targeted push messages.

These audiences can be also defined during subscription process and even selected by user before he gives permission to receive push notification. After this audiences can be managed through API

Add audience

Add audience label to already subscribed user

POST /audience/add

GET query parameters

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

Request body (JSON)

  • audience [string] — Audience text identifier
    Example: "audience": "news"
  • oaid [string]
  • user [string] — User identifier (in publisher hierarchy). Should be set during subscription process or later using cookie-sync mechanism.
    Example: "user": "user@your.site"

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

Delete audience

Delete audience label from your subscriber

POST /audience/del

GET query parameters

  • app [string] — Application key

Request body (JSON)

  • audience [string] — Audience text identifier
    Example: "audience": "news"
  • oaid [string]
  • user [string] — User identifier (in publisher hierarchy). Should be set during subscription process or later using cookie-sync mechanism.
    Example: "user": "user@your.site"

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