API Reference

Create a new segment

post
https://api.pushologies.com/v1/segment

Create a segment to which subscribers can be associated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Name of a segment about to be created.

string

Add more information to better describe the associated subscribers in it.

string
enum

If set to "one-time", the subscriber bucket for the segment will be created immediately. Subsequent notifications which use this segment will use the same subscriber list, meaning this won't include any new subscribers that appear after this segment has been created. If "always" is set, it means for each notification, at the time of each push a new subscriber list will be created using the segment rules, ensuring an always up to date subscriber pool captured by the segment.

Allowed:
rules
array

Rules which will be used to filter subscribers to add to your segment. Full reference can be found on the Segment rules page

rules
boolean

Hide this segment from being viewed in the portalUI and from being returned in standard API requests that are not using the "showHidden" toggle

Responses

401

Id Token or X-API-Key/X-API-Secret is missing or invalid.

403

The server understood the request but refuses to authorize it. In most cases due to insufficient user permissions.

Updated over 2 years ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago