Send a message

Send the specified message with a simple HTTP POST to the Email Campaign API.

Parameters

Name Parameter
Type
Allow
Multiple
Required/
Optional
Data Type Description
Authorization: header false required String (Bearer {access token}) Pass the authentication token that was granted when you authorized access.
id Path False Required String ID of the message. If you are sending a custom message, use an id of custom.
title Data False Optional String A message title.
iscustom Data False Optional String ("Y"|"N") Is a custom message. Valid values: "Y" and "N"
istextonly Data False Optional String ("Y"|"N") Send text-only version. Valid values: "Y" and "N"
issuppressduplicates Data False Optional String ("Y"|"N") Suppress duplicates. Valid values: "Y" and "N"
senderemail Data False Required String The email address to use as the sender. NOTE: This must be a known sender in the Act-On Account.
sendername Data False Required String The name part of the sender.
sendtoids Data False Optional String A comma-separated list of the listid's to which the message will be sent. Either this field or sendtorecids must be present to send.
suppressids Data False Optional String A comma-separated list of the listid's to suppress against.
sendtorecids Data False Optional String A comma-separated list of recipientid's to which send the message will be sent. Either this field or sendtoids must be present.
when Data False Required String When to schedule this send in UNIX epoch timestamp (in milliseconds)*
subject Data False Required String The subject line of the email. This can only be specified if "iscustom"=Y.
htmlbody Data False Optional String If the iscustom field is set, the html part of the email will be set from this field.
textbody Data False Optional String If the iscustom field is set, the text part of the email will be set from this field.
headerid Data False Optional String If the iscustom field is set, the id of the header to use in this message. Note: if the stationary for the message is suppressing headers then the header will not appear even though the header id is set.
footerid Data False Optional String If the iscustom field is set, the id of the footer to use in this message. Note: if the stationary for the message is suppressing footers then the footer will not appear even though the footer id is set.
categoryid Data False Optional String The ID of the subscription management category the message is targeted to. **
logoid Data False Optional String Specify logo for the message. If omitted the default account logo will be used. If you would like to suppress a logo the value "suppress" should be used. ***
whenend Data False Optional String The whenend parameter is used only when the emails should be sent over a time period (staggered between when and whenend). The value is in unix epoch milliseconds*.
timezone Data False Optional String The timezone parameter is used only when the emails should be sent in the recipient's time zone. The timezone parameter is the default time zone used for any recipients that the proper time zone cannot be determined for. The value must be a valid Java TimeZone string (http://tutorials.jenkov.com/java-date-time/java-util-timezone.html is one available list).
createcrmmsgsentnotes Data False Optional Boolean Enable or disable CRM notes when sending to CRM-imported recipient lists. "Y" is enabled by default. Irrespective of how this parameter is set, CRM notes will only be sent if your recipient list includes at least 1 CRM-imported list/segment.
replytoemail Data False Optional String Specify a reply-to email address if it differs from the "From" address. The email address must be a verified sender in the Act-On account.
replytoname Data False Optional String Specify a reply-to first+last name if it should differ from the "From" address.

*Note: See www.epochconverter.com

**Note: Subscription management IDs can be obtained from the Get Subscription Management Category endpoint.

***Note: See the Get Logo List endpoint for how to get a logo ID.

Request

HTTP
Following is an example HTTP request:

CURL
Following is an example curl request:

 

Response

If the request succeeds, you’ll get an HTTP 200 response with a JSON object. Here’s the JSON response from the request made with JSON above:

OAuth
Grant Type Password
Grant Type Code
Grant Type Refresh
Account API
Get account information
Create new account user
Delete account users
Delete account user
Get email senders
Fact API
Upload custom events
Get upload custom event status
List API
Get listing of lists
Download a list
Create a new list
Update or merge a list
Get list upload status
Get rejected records from an upload
Delete a list
Delete records from a list
Get hard bounce list
Get spam complaint list
Get optout list
Update optout list
Get subscription opt-outs by category
mergespecs
uploadspecs
Content API
Get logo list
Get a logo
Add a logo
Update a logo
Delete a logo
Get header list
Get a header
Add a header
Update a header
Delete a header
Get footer list
Get a footer
Add a new footer
Delete a footer
Update a footer
Get image list
Get an image
Add an image
Replace an image
Delete an image
Get media list
Get media file
Add a media file
Add a media link
Update Media File
Delete a media object
Get form list
Get promotional form URLs
Get page list
Get page
Delete page
Get promotional page URLs
Get list of programs
Reporting API
Get message report
Get message report drilldown
Get message report by time period
Get media report
Get media message report
Get a media view report
Get a media timeline report
Get form report
Get page report
Get spam complaint list
Get hard bounce list
Email Campaign API
Get message list
Send a message
Resend a message
Add new template or draft message
Update template or draft message
Delete a message
Get message report
Get message report drilldown
Get message report by time period
Get message HTML contents
Contact API
Add a contact
Get contact record
Upsert a contact record by email
Update a contact by record ID
Delete a contact
Get contact record ID based on cookie value
Get contact from list based on cookie ID or e-mail
Get contact fact and score data
Get subscription categories
Opt in/Opt out subscription category by email address
Get subscription category opt-ins by email
Opt in/Opt out multiple subscription categories by email address
SEO API
Get SEO keywords
Get a new SEO report
Frequently Asked Questions