« Back to Documentation Overviewset_account_callbacks
Section: Callbacks
Version: 1.5.0
Set callbacks configuration for account.
Conditions:
- uri (mandatory) – Location of callback listener.
- actions (mandatory) – List of actions that will be reported to callback listener. Allowed values are subscribe, open, click, goal, survey, unsubscribe with at least one value required.
Parameters
|
---|
string | API_KEY |
object | string | uri | http://example.com/callback | array | actions | string | subscribe | string | open | string | click | string | goal | string | survey | string | unsubscribe |
|
|
Return Value
|
---|
integer | updated | 1 |
Example Request JSON
[
"API_KEY",
{
"uri": "http:\/\/example.com\/callback",
"actions": [
"subscribe",
"open",
"click",
"goal",
"survey",
"unsubscribe"
]
}
]
Example Response JSON
{
"updated": 1
}
Example Error Response JSON
{
"code": -1,
"message": "Invalid URI"
}
Method-specific Errors
|
---|
Invalid URI |
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 |