Send to an individual subscriber

post

https://push.notifyvisitors.com/api/v1/web/send

This endpoint is used to send a notification to an individual subscriber based on their subscription ID or user ID. The user_id/subscription_id and notification_id are required parameters for this API. If provided, notification details such as title, message, and url will override the default data; otherwise, the values from the notification created in NotifyVisitors panel will be used.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Body Parameter

user_id

string

Unique identification id of the user / Unique id of the user when user subscribed for the push notification.Any one from user_id or subscription_id is required

subscription_id

string

Push Subscription id of the user generated when user subscribed for the push notification.Any one from user_id or subscription_id is required

notification_id

int64

Unique id that is assigned while creating a push notification.Any one from user_id or subscription_id is required

tag

string

Tags are assigned to the users to segment them on the basis of specific factors

time

int64

Send notification after x no of seconds

title

string

Maximum character limit for the title must be 55 characters

message

string

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

url

string

Call to action 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 600 * 400 Pixels. Works only for chrome subscribers

mobile_hero_image_url

string

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

template

string

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

button_one_title

string

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

button_one_image

string

Action buttons allowed only in chrome version 48 and above

button_one_url

string

Works only for chrome subscribers

button_two_title

string

Allowed only in chrome version 48 and above

button_two_image

string

Action buttons allowed only in chrome version 48 and above

button_two_url

string

Works only for chrome subscribers

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