EMAIL CAMPAIGNS API

NotifyVisitors API endpoints enable you to send email campaigns to the users to nudge them to subscribe to your services and in turn perform actions that turn them into loyal customers. You can send the email campaigns to a specific user, to all the users, or to a specific segment.

Call on the below API to send email campaigns to the users :

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

API Endpoints For Different Segments:

To a specific user

  • You can send email campaigns to specific users on the basis of their phone numbers or email addresses via the below API endpoint.
https://mail.notifyvisitors.com/api/v1/sendMessage

You have to send the post parameters such as email campaign ID or user ID to an API endpoint.

To all the users

  • Call the below API endpoints to send email campaigns to all the users.
https://mail.notifyvisitors.com/api/v1/email/broadcast/all

Sender name, sender email, and campaign name are the post parameters that you have to send as the post parameters to the API endpoint.

To a specific segment

  • Call the below API endpoints to send email campaigns to the users of a specific segment.
https://mail.notifyvisitors.com/api/v1/email/broadcast/segment

Sender email, sender name, and segment Id are the post parameters that you have to send as the post parameters to the API endpoint.

API Rate Limit

  • The API rate limit is the number of times the API can be requested per minute.
  • You can make up to 500 API requests per minute on an API.
  • If the limit exceeds, the app will throw an error in Response. All API requests are subject to rate limits.

PASS THE EMAIL VARIABLES AS PARAMETERS IN THE REQUEST BODY:

See the below example

curl --request POST \
  --url https://mail.notifyvisitors.com/api/v1/sendMessage
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-api-key: 078F9614571CE78626C6C68D2E89A5CA' \
  --header 'x-brand-id:8127'\
  --data '{"sender_name":"John Doe",
  "service provider_id":3456,
  "campaign_name":" marketing campaign",
  "schedule_date ":"08-12-2020,
  "url":"https://www.notifyvisitors.com/"
PARAMETERSTYPEDESCRIPTIONMANDATORY
sender_namestringName of the senderYes
sender_emailstringEmail of the senderYes
subjectstringSubject of emailYes
campaign_namestringName of the campaignYes
contentstringContent of the
campaign
Yes
serviceproviderIDintegerId of the service providerYes
segment_idintegerUnique id of the segment in which the user fallsYes
schedule_dateintegerScheduled date for the email campaignYes
schedule_timeintegerSchedule time for the email campaignYes
track_openbooleanTrack the Email opensNo
track_clickbooleanTrack the clicks on the emailNo
track_replybooleanTrack the reply on the mailsNo
reply_tostringResponses to the email campaignNo
email_ccstringOther recipients of the mailNo
frequency_cappingbooleanNo. of times email shall be send to the usersNo
dndbooleanDo not disturb setting when the email shall not be send to the usersNo