« Back to Documentation Overviewget_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
|
---|
string | API_KEY |
object | string | campaign | CAMPAIGN_ID |
|
Return Value
|
---|
object | CAMPAIGN_ID | string | name | my_campaign_1 | string | description | My campaign | string | optin | single | string | from_name | My From Name | string | from_email | me@emailaddress.com | string | reply_to_email | replies@emailaddress.com | string | created_on | 2010-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 |