« Back to Documentation Overview

get_message

Section: Messages
Version: 1.5.0


Get single message using MESSAGE_ID.


Parameters
stringAPI_KEY
object
stringmessageMESSAGE_ID
Return Value
objectMESSAGE_ID
stringcampaignCAMPAIGN_ID
stringtypeautoresponder
stringstatusactive
stringsubjectMy autoresponder
arraycontent_types
stringplain
stringhtml
stringnameSecond week start
stringbased_ontime
integerday_of_cycle8
arraydays_of_week
stringMonday
stringTuesday
stringWednesday
stringThursday
stringFriday
integerdelay_hours4
stringtime_travelyes
arrayflags
stringclicktrack
stringopenrate
stringcreated_on2010-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