APIs

Send to a specific segment

post
https://push.notifyvisitors.com/api/v1/web/broadcast/segment

This API is used to send a notification to a specific segment of users. The title, message, URL, and segment_id are required parameters for this API.

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

Body Parameter

int64

Unique segment id

string

Notification Name

string

Maximum character limit for the title must be 25 characters

string

Maximum character limit for the push notification message should be 35 characters

string

Call to action url

int64

Schedule Date (2020-01-13)

int64

Schedule Time (12:16:00)

int64

Time Zone ( default 0 )

int64

1 -> standard (image_url), 2 -> rich (image_url, hero_image_url , mobile_hero_image_url)

string

Image URL must be on HTTPs. Image URL size must be 200 * 200 Pixels

string

URL needs to be on HTTPs. Hero image URL size must be 600 * 400 Pixels. Works only for chrome subscribers

string

Maximum size for mobile hero image URL must be 512 * 256 Pixels

string

1 -> chrome, 2 -> mozilla firefox, 5 -> Safari, 6 -> Microsoft Edge (comma seprated value Ex : 1,2,5)

string

Maximum Length of the call-to-action button must be 12 characters. Works only for chrome subscribers

string

Action buttons allowed only in chrome version 48 and above

string

Works only for chrome subscribers

string

Allowed only in chrome version 48 and above

string

Action buttons allowed only in chrome version 48 and above

string

Works only for chrome subscribers

json

Set life time of the message in JSON format. ex - { 'days':10, 'hours':0, 'minutes':1 }

Headers
integer
required

Brand id of notifyvisitors account

string
required

Api key of notifyvisitors

Responses

Updated over 1 year ago

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

Updated over 1 year ago