/servlet/control/api/campaigns/update
Allows you to update the properties of an existing campaign. Only properties that are provided in the request will be updated. All other properties will remain unchanged and keep their existing values. Please reference create for actual data requirements if you are unsure which fields are required.
/servlet/control/api/campaigns/update
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
|---|---|---|---|---|---|
| secret | String | Yes | a78bf24c5a23581aceba1c5f51ac4cad | Must be a String containing no more than 32 characters | |
| output | String | No | xml | Must be a String equal to either json or xml | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| id | Integer | Yes | 123 | Must be the ID# of an existing campaign | |
| name | String | No | ACME 468x60 Banner | Must be a String containing no more than 80 characters | |
| status | boolean | No | true | Must be a boolean value equal to either true or false | |
| notes | String | No | N/A | Must be a String containing no more than 65,535 characters | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| alerts_recipients_administrators | CSV Integer | No | N/A | This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing administrator(s). If any types of alerts are enabled, at least one recipient must be specified. That can be an administrator, the advertiser, or other e-mail addresses for non-system users so long as there is at least one recipient out of those three types of users. | |
| alerts_recipients_advertiser | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_recipients_others | CSV | No | N/A | Must be a CSV list of e-mail addresses separated by line breaks and containing no more than 65,535 characters | |
| alerts_report_type | Integer | No | 0 |
Must be an Integer equal to one of the following values:
|
|
| alerts_report_range | Integer | No | 0 |
Must be an Integer equal to one of the following values:
|
|
| alerts_report_data_custom | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_report_data_daily | boolean | No | true | Must be a boolean value equal to either true or false | |
| alerts_report_data_geography | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_report_data_groups | boolean | No | true | Must be a boolean value equal to either true or false | |
| alerts_report_data_hourly | boolean | No | true | Must be a boolean value equal to either true or false | |
| alerts_report_data_keywords | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_report_data_media | boolean | No | true | Must be a boolean value equal to either true or false | |
| alerts_report_data_network | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_report_data_publishers | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_report_data_referrer | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_report_data_software | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_report_data_zones | boolean | No | true | Must be a boolean value equal to either true or false | |
| alerts_startdate | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_stopdate | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_days | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_days_trigger | Integer | No | 1 | Must be an Integer value between 1 and 31 if alerts_days is true | |
| alerts_views | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_views_trigger | Integer | No | 5 | Must be an Integer value between 5 and 95 if alerts_views is true | |
| alerts_clicks | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_clicks_trigger | Integer | No | 5 | Must be an Integer value between 5 and 95 if alerts_clicks is true | |
| alerts_actions | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_actions_trigger | Integer | No | 5 | Must be an Integer value between 5 and 95 if alerts_actions is true | |
| alerts_max_views | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_max_clicks | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_max_actions | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_periodic | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_periodic_trigger | Integer | No | 0 |
Must be an Integer equal to one of the following values if alerts_periodic is true:
|
|
| alerts_views_increment | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_views_increment_trigger | Integer | No | 10,000 | Must be an Integer value greater than zero if alerts_views_increment is true | |
| alerts_clicks_increment | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_clicks_increment_trigger | Integer | No | 100 | Must be an Integer value greater than zero if alerts_clicks_increment is true | |
| alerts_actions_increment | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_actions_increment_trigger | Integer | No | 10 | Must be an Integer value greater than zero if alerts_actions_increment is true | |
| alerts_over_delivery | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_over_delivery_trigger | Integer | No | 5 | Must be an Integer value between 5 and 95 if alerts_over_delivery is true | |
| alerts_under_delivery | boolean | No | false | Must be a boolean value equal to either true or false | |
| alerts_under_delivery_trigger | Integer | No | 5 | Must be an Integer value between 5 and 95 if alerts_under_delivery is true | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| custom_operator[1-10] | Integer | No | 1 |
Must be an Integer equal to one of the following values:
|
|
| custom_data[1-10] | CSV | No | N/A | Must be a CSV list of target values separated by line breaks and containing no more than 65,535 characters | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| schedule_start_date | Date | No | 2011-01-01 | Must be a Date in yyyy-MM-dd format | |
| schedule_start_hour | Integer | No | 12 | Must be an Integer value between 0 and 23 based on 24-hour clock convention | |
| schedule_start_minute | Integer | No | 30 | Must be an Integer value between 0 and 59 based on 60-minute clock convention | |
| schedule_stop_date | Date | No | 2011-01-31 | Must be a Date in yyyy-MM-dd format | |
| schedule_stop_hour | Integer | No | 23 | Must be an Integer value between 0 and 23 based on 24-hour clock convention | |
| schedule_stop_minute | Integer | No | 59 | Must be an Integer value between 0 and 59 based on 60-minute clock convention | |
| schedule_weekdays | CSV Integer | No | N/A |
This multiple value parameter can be in the form of either a single CSV parameter value or multiple
parameter values and may include one or more of the following Integer values:
|
|
| schedule_hours | Integer | No | N/A | This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and may include one or more Integer values between 0 and 23 based on 24-hour clock convention. | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| capping_view_limit | Integer | No | 0 | Must be an Integer value greater than or equal to zero -- if equal to zero then view capping is disabled | |
| capping_view_timeout | Integer | No | 1440 | Must be an Integer value between 1 and 129,600 if capping_view_limit is greater than zero. The unit of measure for this value is minutes. Thus it's possible to set it between 1 minute and 90 days (60 minutes * 24 hours * 90 days = 129,600 minutes). | |
| capping_click_limit | Integer | No | 0 | Must be an Integer value greater than or equal to zero -- if equal to zero then click capping is disabled | |
| capping_click_timeout | Integer | No | 1440 | Must be an Integer value between 1 and 129,600 if capping_click_limit is greater than zero. The unit of measure for this value is minutes. Thus it's possible to set it between 1 minute and 90 days (60 minutes * 24 hours * 90 days = 129,600 minutes). | |
| capping_action_limit | Integer | No | 0 | Must be an Integer value greater than or equal to zero -- if equal to zero then action capping is disabled | |
| capping_action_timeout | Integer | No | 1440 | Must be an Integer value between 1 and 129,600 if capping_action_limit is greater than zero. The unit of measure for this value is minutes. Thus it's possible to set it between 1 minute and 90 days (60 minutes * 24 hours * 90 days = 129,600 minutes). | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| limits_maxviews | Long | No | 0 | Must be an Long value greater than or equal to zero. If equal to zero the campaign will run with unlimited views. If greater than zero, the campaign will expire when the specified number of views has been delivered. | |
| even_distribute | boolean | No | false | Must be a boolean value equal to either true or false. Can only be set to true if a schedule_start_date, schedule_stop_date, and limits_maxviews have been specified. In addition, the start and stop dates must both be in the future and the stop date must be after the start date. | |
| limits_maxclicks | Long | No | 0 | Must be an Long value greater than or equal to zero. If equal to zero the campaign will run with unlimited clicks. If greater than zero, the campaign will expire when the specified number of clicks has been delivered. | |
| limits_maxactions | Long | No | 0 | Must be an Long value greater than or equal to zero. If equal to zero the campaign will run with unlimited actions. If greater than zero, the campaign will expire when the specified number of actions has been delivered. | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| geography_continent | CSV Integer | No | N/A |
This multiple value parameter can be in the form of either a single CSV parameter value or multiple
parameter values and may one or more of the following Integer values:
|
|
| geography_continent_unknown | boolean | No | false | Must be a boolean value equal to either true or false | |
| geography_country | CSV String | No | N/A | This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and may include one or more ISO 3166 standard country codes: Country Code Reference List | |
| geography_country_unknown | boolean | No | false | Must be a boolean value equal to either true or false | |
| geography_state_province | CSV | No | N/A | Must be a CSV list of non-abbreviated state/province names separated by line breaks and containing no more than 65,535 characters. For US states and Canadian provinces you may use ISO 3166-2 standard abbreviations: US/Canada State/Province Abbreviations List Upon creation of the campaign, the abbreviations will be automatically converted into their full names. | |
| geography_state_province_unknown | boolean | No | false | Must be a boolean value equal to either true or false | |
| geography_city | CSV | No | N/A | Must be a CSV list of non-abbreviated city names separated by line breaks and containing no more than 65,535 characters | |
| geography_city_unknown | boolean | No | false | Must be a boolean value equal to either true or false | |
| geography_postal | CSV | No | N/A | Must be a CSV list of zip/postal codes separated by line breaks and containing no more than 65,535 characters | |
| geography_postal_unknown | boolean | No | false | Must be a boolean value equal to either true or false | |
| geography_dma | CSV Integer | No | N/A | This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and may include one or more designated marketing area codes: DMA Code Reference List | |
| geography_dma_unknown | boolean | No | false | Must be a boolean value equal to either true or false | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| keywords_target | CSV | No | N/A | Must be a CSV list of keywords and phrases separated by line breaks and containing no more than 65,535 characters. Keywords and phrases can be matched with fuzzy or exact algorithms, required, excluded, or by frequency. Please see the Keyword Targeting Syntax Reference for more information and examples. | |
| keywords_force | boolean | No | true | Must be a boolean value equal to either true or false | |
| keywords_block | CSV | No | N/A | Must be a CSV list of keywords and phrases separated by line breaks and containing no more than 65,535 characters. Keywords and phrases can be matched with fuzzy or exact algorithms, required, excluded, or by frequency. Please see the Keyword Targeting Syntax Reference for more information and examples. | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| network_target_ips | CSV | No | N/A | Must be a CSV list of IP addresses separated by line breaks and containing no more than 65,535 characters. Wildcards in the form of [0-255] can be used to match ranges of IP addresses. For example, you can use 192.168.1.[32-64] to match all IP addresses from 192.168.1.32 through 192.168.1.64. Additionally, partial IP addresses can be entered, such as 192.168.1. to match all IP addresses from 192.168.1.1 to 192.168.1.255 because IP addresses are matched from left to right. | |
| network_block_ips | CSV | No | N/A | Must be a CSV list of IP addresses separated by line breaks and containing no more than 65,535 characters. Wildcards in the form of [0-255] can be used to match ranges of IP addresses. For example, you can use 192.168.1.[32-64] to match all IP addresses from 192.168.1.32 through 192.168.1.64. Additionally, partial IP addresses can be entered, such as 192.168.1. to match all IP addresses from 192.168.1.1 to 192.168.1.255 because IP addresses are matched from left to right. | |
| network_target_hosts | CSV | No | N/A | Must be a CSV list of hostnames separated by line breaks and containing no more than 65,535 characters. Wildcards in the form of * can be used to match variations of hostnames. For example, you can enter *.earthlink.net to match any hostname for that domain. Note that you can also use *.earthlink.* to match .com, .org, .net, etc... versions of a domain. | |
| network_block_hosts | CSV | No | N/A | Must be a CSV list of hostnames separated by line breaks and containing no more than 65,535 characters. Wildcards in the form of * can be used to match variations of hostnames. For example, you can enter *.earthlink.net to match any hostname for that domain. Note that you can also use *.earthlink.* to match .com, .org, .net, etc... versions of a domain. | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| publishers | CSV Integer | No | N/A | This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must be the ID# of an existing publisher(s) | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| rates_advertiser_cpm | Double | No | 5.00 | Must be a Double greater than or equal to 0.00 | |
| rates_advertiser_cpc | Double | No | 1.25 | Must be a Double greater than or equal to 0.00 | |
| rates_advertiser_cpa | Double | No | 25.00 | Must be a Double greater than or equal to 0.00 | |
| rates_advertiser_flat | Double | No | 2500.00 | Must be a Double greater than or equal to 0.00 | |
| rates_publisher_cpm | Double | No | 5.00 | Must be a Double greater than or equal to 0.00 | |
| rates_publisher_cpc | Double | No | 1.25 | Must be a Double greater than or equal to 0.00 | |
| rates_publisher_cpa | Double | No | 25.00 | Must be a Double greater than or equal to 0.00 | |
| rates_publisher_flat | Double | No | 2500.00 | Must be a Double greater than or equal to 0.00 | |
| rates_notes | String | No | N/A | Must be a String containing no more than 65,535 characters | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| referrer_target | CSV | No | N/A | Must be a CSV list of URL(s) or path/file name patterns separated by line breaks and containing no more than 65,535 characters. Wildcards such as http://google.* may be used to match .com, .org, .net, etc... variations of a domain. Partial referrers may be entered, such as http://cnn.com/ to match all referrers that start with http://cnn.com/ since referrers are matched from left to right. Additionally, the www. prefix is stripped from referrers prior to comparison, so http://www.cnn.com/ is treated as equal to http://cnn.com/ | |
| referrer_block | CSV | No | N/A | Must be a CSV list of URL(s) or path/file name patterns separated by line breaks and containing no more than 65,535 characters. Wildcards such as http://google.* may be used to match .com, .org, .net, etc... variations of a domain. Partial referrers may be entered, such as http://cnn.com/ to match all referrers that start with http://cnn.com/ since referrers are matched from left to right. Additionally, the www. prefix is stripped from referrers prior to comparison, so http://www.cnn.com/ is treated as equal to http://cnn.com/ | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| retargeting_min_days | Integer | No | 0 | Must be an Integer between 0 and 1,825 (up to 5 years) | |
| retargeting_max_days | Integer | No | 90 | Must be an Integer between 0 and 1,825 (up to 5 years) | |
| retargeting_target | CSV String | No | N/A | This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and may include one or more segment aliases. | |
| retargeting_block | CSV String | No | N/A | This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and may include one or more segment aliases. | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| software_browser | CSV Integer | No | N/A |
This multiple value parameter can be in the form of either a single CSV parameter value or multiple
parameter values and may include one or more of the following Integer values:
|
|
| software_os | CSV Integer | No | N/A |
This multiple value parameter can be in the form of either a single CSV parameter value or multiple
parameter values and may include one or more of the following Integer values:
|
|
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| themes | CSV Integer | No | N/A | This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must be the ID# of an existing theme(s) |
/servlet/control/api/campaigns/update?secret=(key)&id=123&name=ACME+468x60+Banner
<success/>
/servlet/control/api/campaigns/update?secret=(key)&output=json&id=123&name=ACME+468x60+Banner
{ "success" : true }