/servlet/control/api/advertisers/update
Allows you to update the properties of an existing advertiser. 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/advertisers/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 advertiser | |
| name | String | No | ACME Company | Must be a String containing no more than 80 characters | |
| username | String | No | acme | Must be a String containing no more than 16 alphanumeric characters | |
| password | String | No | acme123 | Must be a String containing between 6 and 16 characters | |
| basis | String | No | standard | Must be a String value equal to either standard or budget | |
| status | boolean | No | true | Must be a boolean value equal to either true or false | |
| reminders | 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) | |
| config_home_date_range | String | No | seven |
Must be a String equal to one of the following values:
|
|
| config_home_media_filter | String | No | t_1 | Optionally can be a String equal to t_# or s_# where # is the ID# of a base media type or size | |
| config_home_compare_by | String | No | ecpm |
Must be a String equal to one of the following values:
|
|
| config_home_item_count | Integer | No | 25 | Must be an Integer between 25 and 100 | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| config_recent_email_frequency | String | No | never |
Must be a String equal to one of the following values:
|
|
| config_recent_email_format | String | No | HTML |
Must be a String equal to one of the following values:
|
|
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| config_reports_hide_graphs | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_hide_empty | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_include_definitions | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_advertiser | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_campaign | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_conversions | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_custom | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_group | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_media | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_publisher | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_zone | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_daily | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_events | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_geography | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_hourly | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_interactive | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_keywords | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_languages | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_network | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_referrer | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_roi | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_size | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_software | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_video | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_viewability | boolean | No | true | Must be a boolean value equal to either true or false | |
| config_reports_data_weather | boolean | No | true | Must be a boolean value equal to either true or false | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| info_company | String | No | ACME | Must be a String containing no more than 48 characters | |
| info_name | String | No | John Doe | Must be a String containing no more than 48 characters | |
| info_title | String | No | Owner | Must be a String containing no more than 48 characters | |
| info_email | No | john@acme.com | Must be an e-mail address containing no more than 64 characters | ||
| info_website | URL | No | http://www.acme.com/ | Must be a HTTP or HTTPS URL containing no more than 64 characters | |
| info_address | String | No | 123 Acme Street New York, NY 10001 | Must be a String containing no more than 65,535 characters | |
| info_phone | String | No | 123-456-7890 | Must be a String containing no more than 48 characters | |
| info_mobile | String | No | 123-456-7890 | Must be a String containing no more than 48 characters | |
| info_fax | String | No | 123-456-7890 | Must be a String containing no more than 48 characters | |
| info_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) | |
| contacts_name[1-5] | String | Maybe | Jane Doe | Must be a String containing no more than 48 characters. Not required by default. However, it is required if contacts_email[1-5] has a value. | |
| contacts_title[1-5] | String | No | Owner | Must be a String containing no more than 48 characters | |
| contacts_email[1-5] | Maybe | jane@acme.com | Must be an e-mail address containing no more than 64 characters. Not required by default. However, it is required if contacts_name[1-5] has a value. | ||
| contacts_phone[1-5] | String | No | 123-456-7890 | Must be a String containing no more than 48 characters | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| permissions | 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 any of the following String values: LOGIN, ACCOUNTS, ACCOUNTS_VIEW, ACCOUNTS_EDIT, MEDIA, MEDIA_LISTING, MEDIA_SEARCH, MEDIA_PREVIEW, MEDIA_VIEW, MEDIA_STATUS, FILES, FILES_NEW, FILES_RENAME, CAMPAIGNS, CAMPAIGNS_LISTING, CAMPAIGNS_SEARCH, CAMPAIGNS_VIEW, CAMPAIGNS_STATUS, REPORTS, REPORTS_ACCOUNTING, REPORTS_GENERAL, REPORTS_CAMPAIGNS, REPORTS_GROUPS, REPORTS_MEDIA, REPORTS_PUBLISHERS, REPORTS_ZONES, REPORTS_CONVERSIONS, REPORTS_CUSTOM, REPORTS_DAILY, REPORTS_ENGAGEMENT, REPORTS_EVENTS, REPORTS_GEOGRAPHY, REPORTS_HOURLY, REPORTS_INTERACTIVE, REPORTS_KEYWORDS, REPORTS_LANGUAGES, REPORTS_NETWORK, REPORTS_REFERRER, REPORTS_ROI, REPORTS_SOFTWARE, REPORTS_VIDEO, REPORTS_VIEWABILITY, REPORTS_WEATHER, TOOLS |
|
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| prebid_adapter | String | No | N/A | Must be the name of a valid Prebid.js adapter that is installed in the system. | |
| prebid_adjustment | Decimal | No | 0.800 | Optional percentage adjustment that can be applied to bids to account for gross versus net, which must be expressed as a decimal between 0.00 and 1.00 | |
| prebid_parameter_name[1-10] | String | No | N/A | Optional parameter names that will be sent with bids. Must be a String containing no more than 48 characters. | |
| prebid_parameter_value[1-10] | String | No | N/A | Optional parameter values that will be sent with bids. Must be a String containing no more than 48 characters. | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| competitors | 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 advertiser(s) | |
| competitors_self | 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) | |
| ga | boolean | No | true | Must be a boolean value equal to either true or false | |
| ga_source | String | No | acme | Must be a String containing no more than 80 characters | |
| ga_medium | String | No | banner | Must be a String containing no more than 80 characters | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| optout | 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 publisher(s) | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| pixels_view | Integer | No | 123 | Must be the ID# of an existing pixel | |
| pixels_click | Integer | No | 123 | Must be the ID# of an existing pixel | |
| pixels_action | Integer | No | 123 | Must be the ID# of an existing pixel | |
| pixels_retargeting | Integer | No | 123 | Must be the ID# of an existing pixel | |
| Parameter Name | Parameter Type | Required? | Example Value | Validation Rules (If Applicable) | |
| regulations_actions | String | No | N/A | Must be the alias of an existing segment, which will render actions non-countable when users are tagged with it. | |
| regulations_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 | |
| regulations_keywords | CSV String | No | N/A | Must be a CSV list of keywords and phrases separated by line breaks and containing no more than 262,144 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) | |
| roadblock_campaigns | 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 campaign(s) | |
| roadblock_zones | 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 zone(s) |
/servlet/control/api/advertisers/update?secret=(key)&id=123&name=ACME+Company
<success/>
/servlet/control/api/advertisers/update?secret=(key)&output=json&id=123&name=ACME+Company
{ "success" : true }