Schedule a notification for a Segment

post

https://pushcrew.com/api/v1/send/segment/:segmentId

This endpoint is used to schedule a notification for a segment of subscribers. The request method of this call needs to be "POST". This feature is only available for premium plans and above.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Response Description:

Scheduled Notification Request ID: An integer sent to identify the scheduling request sent by you to our API.

Status: To denote whether push request succeeded or not. Values can be 'success' or 'failure'

Message: Used to denote success or reason of failure.

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 of the push notification.

schedule

int32

required

To be sent as '1'. This is an integer used to denote that this notification needs to be scheduled.

date

required

The date on which the scheduled notification should go out. Should be in YYYY-MM-DD format.

time

string

required

The time on which the scheduled notification should go out. This needs to be according to UTC/GMT timezone. Format: HH:MM:SS

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.

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.

Responses

Response Description:

200200

400400

401401

500500