Send to a List of Subscribers

post

https://pushcrew.com/api/v1/send/list

This endpoint is used to send a notification to a specified list of subscribers. The request method of this call needs to be "POST".

The title, message and url of the notification have to be sent as POST parameters to the API endpoint.

URL of the image to be shown in the notification needs to point to a 192 x 192 PNG. If this is not provided, the default company logo will be shown in the notification.

Body Params

title

string

required

To be sent as a POST Parameter. Title of the Push Notification. Maximum of 35 chars.

message

string

required

To be sent as a POST Parameter. Message to be displayed in the Push Notification. Maximum of 80 chars.

url

string

required

To be sent as a POST Parameter. URL to open upon clicking the push notification

subscriber_list

string

required

To be sent as a POST Parameter. JSON Object containing array of Subscriber ID's

image_url

string

URL of the icon to be shown in the notification. URL needs to be on HTTPS and needs to point to a 192 x 192 PNG. If this is not provided, the default company logo will be shown in the notification.

hero_image_url

string

This feature can only be used by business and enterprise accounts. To be sent as a POST parameter. URL of the big image to be shown in the notification. URL needs to be on HTTPS and needs to point to an image file. Please note that this only works for Chrome subscribers. Firefox does not support this as of now.

button_one_label

string

This feature can only be used by business and enterprise accounts. To be sent as a POST parameter. This is the label of the first call-to-action button which will be shown in the notification. Maximum length of this parameter is 12 characters. Please note that this only works for Chrome subscribers. Firefox does not support this as of now.

button_one_url

string

This feature can only be used by business and enterprise accounts. To be sent as a POST parameter. This is the URL which will open upon clicking the first call-to-action button shown in the notification. Please note that this only works for Chrome subscribers. Firefox does not support this as of now.

button_two_label

string

This feature can only be used by business and enterprise accounts. To be sent as a POST parameter. This is the label of the second call-to-action button which will be shown in the notification. Maximum length of this parameter is 12 characters. Please note that this only works for Chrome subscribers. Firefox does not support this as of now.

button_two_url

string

This feature can only be used by business and enterprise accounts. To be sent as a POST parameter. This is the URL which will open upon clicking the second call-to-action button shown in the notification. Please note that this only works for Chrome subscribers. Firefox does not support this as of now.

time_to_live

int32

Defaults to 2419200

To be sent as a POST Parameter. This parameter is used to control the time up till which the notification should be attempted if the subscriber is offline. Pass the number of seconds elapsed after which the notification should not be sent. Default value(2419200) stands for 4 weeks.

autohide_notification

int32

Defaults to 1

To be sent as a POST parameter. '1' denotes that the notification will remain on screen until it's clicked or closed. '0' denotes that the notification will auto-hide(if not clicked upon or closed) after 20 seconds.

ignore_inactive_subscribers

int32

Defaults to 0

To be sent as a POST Parameter. '1' denotes that the notification will be sent even if the subscriber_list parameter has invalid subscribers. '0' denotes that the notification will not be sent if the subscriber_list parameter has invalid subscribers. invalid_list will be returned in response in both the cases which will have the list of invalid subscriber ids.

Responses

200200

400400

401401

500500