« Back to Documentation Overview

get_campaigns

Section: Campaigns
Version: 1.5.0


Get list of campaigns in account.


Parameters
stringAPI_KEY
object
objectname
stringOPERATORvalue
Return Value
objectCAMPAIGN_ID
stringnamemy_campaign_2
stringdescriptionget_campaigns_description__string
stringoptindouble
stringfrom_nameMy From Name
stringfrom_emailme@emailaddress.com
stringreply_to_emailreplies@emailaddress.com
stringcreated_on2010-01-01 00:00:00

Example Request JSON

[
    "API_KEY",
    {
        "name": {
            "OPERATOR": "value"
        }
    }
]

Example Response JSON

{
    "CAMPAIGN_ID": {
        "name": "my_campaign_2",
        "description": null,
        "optin": "double",
        "from_name": "My From Name",
        "from_email": "me@emailaddress.com",
        "reply_to_email": "replies@emailaddress.com",
        "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