ad.call_postback.set
Sets the Call End Postback URL for the specified ad campaign.
Request syntax
{
"jsonrpc": "2.0",
"id": 1,
"method": "ad.call_postback.set",
"params": [
"campaign_id",
"call_end_postback"
]
}
Request parameters
The request contains the following positional parameters. All of the parameters are required, and they must be in the order listed in the Request syntax.
- campaign_id
- Required string. The unique, system-generated ID that identifies an ad campaign.
- call_end_postback
- Required string, which can contain up to 256 characters. The Call End Postback URL for the specified ad campaign. If the campaign already has a URL, it is replaced with the specified URL. You can specify an empty string (two double quotes) to delete a URL. See RFC1738: Uniform Resource Locators (URL) for detailed information on the characters safe to use in URLs.
Response syntax
{
"jsonrpc": "2.0",
"id": 1,
"result": integer
}
Response parameters
- result
- An integer that indicates successful completion of the method. If the method was unsuccessful, an error object is returned instead of this result value.
Permissions
The API user must be a Group Admin of the group that the specified campaign belongs to. Note that users with the Account Admin permission are Group Admins of all groups in an account, and parent account users with the Client Admin permission are Group Admins of all groups in all sub-accounts.
Example
The following JSON-RPC request and response describe a successful call to the ad.call_postback.set method. The request sets the call end postback URL for the specified ad campaign to "http://mydomain.com/call_postback".
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "ad.call_postback.set",
"params": [
"CtjSZlGlCNZF0AAm",
"http://mydomain.com/call_postback"
]
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": 17
}