POST https://restapi.actonsoftware.com/api/1/message/{id}/send
This endpoint allows you to send an email from the account.
Parameters
| Name | Parameter Type |
Allow Multiple |
Required/ Optional |
Data Type | Description |
|---|---|---|---|---|---|
| Authorization: | header | false | required | String | Insert your generated access token. ("Bearer {access token}") |
| id | Path | False | Required | String | If custom set the value to "custom" otherwise specify the ID of the Draft, Template, or Previously Sent Message. |
| title | Data | False | Optional | String | Specify the title of the message. |
| iscustom | Data | False | Optional | String | Is this a custom message? ("Y","N") |
| istextonly | Data | False | Optional | String | Are you sending a text-only message? ("Y","N") |
| istransactional | Data | False | Optional | String | Are you sending a transactional message? ("Y","N") |
| issuppressduplicates | Data | False | Optional | String | Do you want to suppress duplicates? ("Y","N") |
| senderemail | Data | False | Required | String | Specify the verified sender email address. |
| sendername | Data | False | Required | String | Specify the verified sender name. |
| sendtoids | Data | False | Required | String | Specify the list IDs if you are sending complete lists. (Comma-Separated) |
| suppressids | Data | False | Optional | String | Specify the list IDs of lists you would like to suppress against this send. (Comma-Separated) |
| sendtorecids | Data | False | Optional | String | Specify the record IDs if you are sending to specific records. (Comma-Separated) |
| when | Data | False | Required | String | Specify when the message should be sent. ("UNIX epoch timestamp") |
| subject | Data | False | Required | String | If custom, specify a subject for the message. |
| htmlbody | Data | False | Optional | String | If custom, specify the HTML for the message. |
| textbody | Data | False | Optional | String | If custom, specify the TEXT body for the message. |
| headerid | Data | False | Optional | String | If custom, specify the header ID for the message. |
| footerid | Data | False | Optional | String | If custom, specify the footer ID for the message. |
| categoryid | Data | False | Optional | String | Specify the category ID of the subscription category to use for the message. |
| logoid | Data | False | Optional | String | If custom, specify the logo ID for the message. |
| whenend | Data | False | Optional | String | If sending over time specify the time when you want the message end. ("UNIX epoch timestamp") |
| timezone | Data | False | Optional | String | If sending in the recipients time set the fallback timezone if no timezone is present. |
| createcrmmsgsentnotes | Data | False | Optional | Boolean | If sending to a CRM list do you want to send a CRM note? ("true","false") |
| replytoemail | Data | False | Optional | String | Specify the verified reply-to email address. |
| replytoname | Data | False | Optional | String | Specify the verified reply-to email name. |
Parameter Notes
istransactional
Transactional email must be enabled on the account (More Information)
when
You can generate a timestamp using http://www.epochconverter.com/
timezone
An example list of timezone values can be found here http://tutorials.jenkov.com/java-date-time/java-util-timezone.html
htmlbody
Adding a custom htmlbody is equivalent to adding a custom content block to an Act-On email.
Response
{
"status": "success",
"message": "Message scheduled for launch: s-0003-1910, API requested msgID: d-0003"
}
Code Examples
cURL
curl -X POST https://restapi.actonsoftware.com/api/1/message/d-0003/send -H 'Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs' -H 'Content-Type: application/x-www-form-urlencoded' -d 'senderemail=john.doe@act-on.com&sendername=John&when=1544559007000&sendtoids=l-0002'