« Back to Documentation Overviewget_message
Section: Messages
Version: 1.5.0
Get single message using MESSAGE_ID.
Parameters
|
---|
string | API_KEY |
object | |
Return Value
|
---|
object | MESSAGE_ID | string | campaign | CAMPAIGN_ID | string | type | autoresponder | string | status | active | string | subject | My autoresponder | array | content_types | | string | name | Second week start | string | based_on | time | integer | day_of_cycle | 8 | array | days_of_week | string | Monday | string | Tuesday | string | Wednesday | string | Thursday | string | Friday |
| integer | delay_hours | 4 | string | time_travel | yes | array | flags | string | clicktrack | string | openrate |
| string | created_on | 2010-01-01 00:00:00 |
|
Example Request JSON
[
"API_KEY",
{
"message": "MESSAGE_ID"
}
]
Example Response JSON
{
"MESSAGE_ID": {
"campaign": "CAMPAIGN_ID",
"type": "autoresponder",
"status": "active",
"subject": "My autoresponder",
"content_types": [
"plain",
"html"
],
"name": "Second week start",
"based_on": "time",
"day_of_cycle": 8,
"days_of_week": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday"
],
"delay_hours": 4,
"time_travel": "yes",
"flags": [
"clicktrack",
"openrate"
],
"created_on": "2010-01-01 00:00:00"
}
}
API-wide Errors
|
---|
API key verification failed
| API key verification failed |
API client IP not allowed
| API client IP not allowed |
Invalid params
| Attribute params must be reference to hash |