Upload Campaign with Visible TO Recipients
Send a campaign with an uploaded HTML body (ZIP) where every recipient in the TO field is visible to all other recipients.
| Endpoint | https://enterprise.webaroo.com/GatewayAPI/rest |
| Method | EMS_UPLOAD_CAMPAIGN |
| HTTP methods | POST (up to 5 attachments) |
Account-level featureTO recipient visibility must be enabled on your Enterprise account before you can use this.
Limits
- Recipients must be a comma-separated list, maximum 50 per request.
- CC and BCC are not supported, because all TO recipients are visible.
Request
curl --location --request POST 'https://enterprise.webaroo.com/GatewayAPI/rest' \
--form 'method="EMS_UPLOAD_CAMPAIGN"' \
--form 'userid="xxxxxxxxxx"' \
--form 'password="xxxxxx"' \
--form 'v="1.1"' \
--form 'name="QA%201"' \
--form 'content_type="text/html"' \
--form 'fromEmailId="[email protected]"' \
--form 'subject="Verify%20EMS_POST%204"' \
--form 'newsletter_file=@"/C:/Users/test/Downloads/example_Testing.zip"' \
--form 'recipients="[email protected],[email protected]"' \
--form 'replyToEmailId="[email protected]"' \
--form 'attachment1=@"/C:/Users/TEST/Downloads/EnterpriseEmailAPIDocument.pdf"'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. | YOUR_PASSWORD |
method | string | Yes | Must be EMS_UPLOAD_CAMPAIGN. | EMS_UPLOAD_CAMPAIGN |
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 | string | Yes | Comma-separated recipient email IDs (max 50). | [email protected],[email protected] |
newsletter_file | file | Yes | Email body as a ZIP file. | @"/C:/Users/TEST/Downloads/newsletter.zip" |
name | string | No | Sender name shown to the recipient. | X Company |
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 10 hours ago
Did this page help you?