Send to Particular Segment

post

https://push.notifyvisitors.com/api/v1/android/broadcast/segment

This endpoint is used to send a notification to subscribers of a particular segment. segmentID is required. The title, message and url of the notification have to be sent as POST parameters to the API endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Body Parameter

segment_id

int64

Unique segment id

name

string

Notification Name

title

string

Maximum character limit for the title must be 70 characters

message

string

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

url

string

0 -> Android Activity, 1 -> Url, 2 -> Package Name, 3 -> Share, 4 -> Call

target

string

Target users while sending push notifications on the basis of their source and location (0 -> Navigate in App , 1 -> Navigate to Webpage , 2 -> Navigate to Third party App, 3 -> Share, 4 -> Call).

schedule_date

int64

Schedule Date (2020-01-13)

schedule_time

int64

Schedule Time (12:16:00)

time_zone

int64

Time Zone ( default 0 )

type

int64

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

image_url

string

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

hero_image_url

string

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

summary

string

An overview of the sent notifications

button_one_title

string

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

button_one_url

string

0 -> Android Activity, 1 -> Url, 2 -> Package Name, 3 -> Share, 4 -> Call , 5 -> Remind me Later (Seconds)

button_one_target

string

0 -> Navigate in App , 1 -> Navigate to Webpage , 2 -> Navigate to Third party App, 3 -> Share, 4 -> Call, 5 -> snooze

button_two_title

string

Allowed only in chrome version 48 and above

button_two_url

string

0 -> Android Activity, 1 -> Url, 2 -> Package Name, 3 -> Share, 4 -> Call , 5 -> Remind me Later (Seconds)

button_two_target

string

0 -> Navigate in App , 1 -> Navigate to Webpage , 2 -> Navigate to Third party App, 3 -> Share, 4 -> Call, 5 -> snooze

message_lifetime

json

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

Headers

x-brand-id

integer

required

Brand id of notifyvisitors account

x-api-key

string

required

Api key of notifyvisitors

Responses

200status

400status

401status

403status

500status