Send to a Specific Segment

post

https://mail.notifyvisitors.com/api/v1/email/broadcast/segment

This endpoint is used to send an email to a specific segment of users.

Body Params

Body Parameter

sender_name

string

Name of the sender

sender_email

string

Email of the sender

subject

string

Subject of email

campaign_name

string

Name of the campaign

content

string

Content of the campaign

serviceproviderID

int64

Id of the service provider

segment_id

int64

Unique id of the segment in which the user falls

schedule_date

date

Scheduled date for the email campaign

schedule_time

date

Schedule time for the email campaign in 24 hours format like 17:40

track_open

boolean

Track the Email opens

track_click

boolean

Track the clicks on the email

track_reply

boolean

Track the reply on the mails

frequency_capping

boolean

No. of times email shall be send to the users

dnd

boolean

Do not disturb setting when the email shall not be send to the users

reply_to

string

Response to the email campaign

email_cc

string

Other recipients of the mail

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