Send a Campaign (Recipient List)

Send an email campaign to a comma-separated list of recipients, with optional CC, BCC, scheduling and attachments.


Endpoint	`https://enterprise.webaroo.com/GatewayAPI/rest`
Method	`EMS_POST_CAMPAIGN`
HTTP methods	`POST` (required for attachments) or `GET` (no attachments)

Request

curl --location --request POST 'https://enterprise.webaroo.com/GatewayAPI/rest' \
--form 'method="EMS_POST_CAMPAIGN"' \
--form 'userid="xxxxxxxxxx"' \
--form 'password="xxxxx"' \
--form 'v="1.1"' \
--form 'content_type="text/html"' \
--form 'name="test1"' \
--form 'fromEmailId="[email protected]"' \
--form 'subject="Verify EMS_POST 4"' \
--form 'recipients="[email protected]"' \
--form 'ccEmailId="[email protected]"' \
--form 'bccEmailId="[email protected]"' \
--form 'content="Hi, This is a EMS_POST_CAMPAIGN"' \
--form 'replyToEmailId="[email protected]"' \
--form 'attachment1=@"/C:/Users/TEST/Downloads/EnterpriseEmailAPIDocument.pdf"' \
--form 'attachment2=@"/C:/Users/TEST/Downloads/Document2.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_POST_CAMPAIGN`.	`EMS_POST_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.	`[email protected],[email protected]`
`name`	string	No	Sender name shown to the recipient.	`X Company`
`fromEmailId`	string	No	Sender email address configured on your account.	`[email protected]`
`content`	string	No	Email body.	`Hi, This is a EMS_POST_CAMPAIGN`
`ccEmailId`	string	No	Comma-separated CC email IDs. Default limit: 10.	`[email protected],[email protected]`
`bccEmailId`	string	No	Comma-separated BCC email IDs. Default limit: 10.	`[email protected],[email protected]`
`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"`

🚧
Attachments require POST
Use POST with multipart form data whenever you send attachments. GET works only for campaigns without attachments.

Response

Success | 1234567890 | Campaign posted

Updated about 11 hours ago

Did this page help you?