« Back to Documentation Overviewget_campaign_postal_address
Section: Campaigns
Version: 1.5.0
Get postal address and postal design (formatting) in campaign. Postal address is attached to every message sent from campaign.
Parameters
|
---|
string | API_KEY |
object | string | campaign | CAMPAIGN_ID |
|
Return Value
|
---|
string | name | My name |
string | address | My address |
string | city | My city |
string | state | My state |
string | zip | My zip |
string | country | My country |
string | design | [[name]], [[address]], [[city]], [[state]] [[zip]], [[country]] |
Example Request JSON
[
"API_KEY",
{
"campaign": "CAMPAIGN_ID"
}
]
Example Response JSON
{
"name": "My name",
"address": "My address",
"city": "My city",
"state": "My state",
"zip": "My zip",
"country": "My country",
"design": "[[name]], [[address]], [[city]], [[state]] [[zip]], [[country]]"
}
Example Error Response JSON
{
"code": -1,
"message": "Missing Campaign"
}
Method-specific Errors
|
---|
Missing Campaign |
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 |