« Back to Documentation Overview

get_campaign

Section: Campaigns
Version: 1.5.0


Get single campaign using CAMPAIGN_ID. Useful for checking which campaign the contact or message belongs to.


Parameters
stringAPI_KEY
object
stringcampaignCAMPAIGN_ID
Return Value
objectCAMPAIGN_ID
stringnamemy_campaign_1
stringdescriptionMy campaign
stringoptinsingle
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",
    {
        "campaign": "CAMPAIGN_ID"
    }
]

Example Response JSON

{
    "CAMPAIGN_ID": {
        "name": "my_campaign_1",
        "description": "My campaign",
        "optin": "single",
        "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