Send to an Uploaded Recipient List
You can upload a file containing all the email addresses and mail them your campaign when using this method. This API will not work if the TO recipient visibility is on.
Upload a CSV file of email addresses and send your campaign to everyone in it. Column values in the file can be used as personalization variables, such as ${name} (see Personalized Campaigns).
| Endpoint | https://enterprise.webaroo.com/GatewayAPI/rest |
| Method | EMS_POST_CAMPAIGN_TO_UPLOADED_ADDRESSES |
| HTTP methods | POST |
Restrictions
- This method does not work when TO recipient visibility is enabled on the account.
- CC and BCC are not supported.
Request
curl --location --request POST 'https://enterprise.webaroo.com/GatewayAPI/rest' \
--form 'method="EMS_POST_CAMPAIGN_TO_UPLOADED_ADDRESSES"' \
--form 'userid="xxxxxxxxxx"' \
--form 'password="xxxxx"' \
--form 'v="1.1"' \
--form 'name="API 2"' \
--form 'subject="Your%20subject%20here"' \
--form 'recipients_file=@"/C:/Users/TEST/Desktop/list.csv"' \
--form 'content="Hi ${name}, Your OTP is ${mobile}. Thank you"' \
--form 'content_type="text/html"' \
--form 'replyToEmailId="[email protected]"' \
--form 'attachment1=@"/C:/Users/TEST/Downloads/EnterpriseEmailAPIDocument.pdf"'
Unicode contentSubjects and content in any language (for example Hindi) are supported when URL-encoded, e.g.
%E0%A4%86%E0%A4%AA%E0%A4%95%E0%A4%BE....
Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
userid | string | Yes | Your Gupshup account user ID. Numeric only, no special characters. | 2000155005 |
password | string | Yes | Password for the user ID. | sh1gw4e |
method | string | Yes | Must be EMS_POST_CAMPAIGN_TO_UPLOADED_ADDRESSES. | EMS_POST_CAMPAIGN_TO_UPLOADED_ADDRESSES |
v | string | Yes | API version. Must be 1.1. | 1.1 |
content_type | string | Yes | Email body type. Must be text/html. | text/html |
subject | string | Yes | Email subject line. | Email Notification for Subscription renewal |
recipients_file | file | Yes | CSV file containing recipient email IDs. | @"/C:/Users/TEST/Desktop/list.csv" |
name | string | No | Sender name shown to the recipient. | X Company |
content | string | No | Email body. | Hi, This is a CAMPAIGN |
scheduled_at | string | No | Send time, URL-encoded, format YYYY-MM-DD HH:mm:ss. | 2020-04-16%2012:53:00 |
replyToEmailId | string | No | Address that receives replies. Must be configured on the account, otherwise the request fails. | [email protected] |
attachment1 … attachment5 | file | No | Files to attach. Total size must not exceed 20 MB. | @"/C:/Users/TEST/Downloads/file.pdf" |
Updated about 12 hours ago
Did this page help you?