Version 5.0
AdvertServe User Manual :: v5.0

Advertisers :: Update API Module

Update

Description

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.

Module URI

Hyperlink /servlet/control/api/advertisers/update

Parameters

Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
secretStringYesa78bf24c5a23581aceba1c5f51ac4cad Must be a String containing no more than 32 characters
outputStringNoxml Must be a String equal to either json or xml
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
idIntegerYes123 Must be the ID# of an existing advertiser
nameStringNoACME Company Must be a String containing no more than 80 characters
usernameStringNoacme Must be a String containing no more than 16 alphanumeric characters
passwordStringNoacme123 Must be a String containing between 6 and 16 characters
basisStringNostandard Must be a String value equal to either standard or budget
statusbooleanNotrue Must be a boolean value equal to either true or false
remindersbooleanNotrue Must be a boolean value equal to either true or false
notesStringNoN/A Must be a String containing no more than 65,535 characters
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
config_home_date_rangeStringNoseven Must be a String equal to one of the following values:
  • today
  • yesterday
  • week
  • seven
  • lastweek
  • fourteen
  • month
  • thirty
  • lastmonth
  • quarter
  • ninety
  • lastquarter
config_home_media_filterStringNot_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_byStringNoecpm Must be a String equal to one of the following values:
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
  • subtotal
  • ecpm
config_home_item_countIntegerNo25 Must be an Integer between 25 and 100
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
config_recent_email_frequencyStringNonever Must be a String equal to one of the following values:
  • never
  • daily
  • monday
  • tuesday
  • wednesday
  • thursday
  • friday
  • saturday
  • sunday
  • weekly
  • biweekly
  • monthly
config_recent_email_formatStringNoHTML Must be a String equal to one of the following values:
  • HTML
  • TXT
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
config_reports_hide_graphsbooleanNotrue Must be a boolean value equal to either true or false
config_reports_hide_emptybooleanNotrue Must be a boolean value equal to either true or false
config_reports_include_definitionsbooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_advertiserbooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_campaignbooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_conversionsbooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_custombooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_groupbooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_mediabooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_publisherbooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_zonebooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_dailybooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_eventsbooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_geographybooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_hourlybooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_interactivebooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_keywordsbooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_languagesbooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_networkbooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_referrerbooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_roibooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_sizebooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_softwarebooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_videobooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_viewabilitybooleanNotrue Must be a boolean value equal to either true or false
config_reports_data_weatherbooleanNotrue Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
info_companyStringNoACME Must be a String containing no more than 48 characters
info_nameStringNoJohn Doe Must be a String containing no more than 48 characters
info_titleStringNoOwner Must be a String containing no more than 48 characters
info_emailEmailNojohn@acme.com Must be an e-mail address containing no more than 64 characters
info_websiteURLNohttp://www.acme.com/ Must be a HTTP or HTTPS URL containing no more than 64 characters
info_addressStringNo123 Acme Street
New York, NY 10001
Must be a String containing no more than 65,535 characters
info_phoneStringNo123-456-7890 Must be a String containing no more than 48 characters
info_mobileStringNo123-456-7890 Must be a String containing no more than 48 characters
info_faxStringNo123-456-7890 Must be a String containing no more than 48 characters
info_notesStringNoN/A Must be a String containing no more than 65,535 characters
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
contacts_name[1-5]StringMaybeJane 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]StringNoOwner Must be a String containing no more than 48 characters
contacts_email[1-5]EmailMaybejane@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]StringNo123-456-7890 Must be a String containing no more than 48 characters
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
permissionsCSV
String
NoN/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 NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
prebid_adapterStringNoN/A Must be the name of a valid Prebid.js adapter that is installed in the system.
prebid_adjustmentDecimalNo0.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]StringNoN/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]StringNoN/A Optional parameter values that will be sent with bids. Must be a String containing no more than 48 characters.
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
competitorsCSV
Integer
NoN/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_selfbooleanNofalse Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
gabooleanNotrue Must be a boolean value equal to either true or false
ga_sourceStringNoacme Must be a String containing no more than 80 characters
ga_mediumStringNobanner Must be a String containing no more than 80 characters
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
optoutCSV
Integer
NoN/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 NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
pixels_viewIntegerNo123 Must be the ID# of an existing pixel
pixels_clickIntegerNo123 Must be the ID# of an existing pixel
pixels_actionIntegerNo123 Must be the ID# of an existing pixel
pixels_retargetingIntegerNo123 Must be the ID# of an existing pixel
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
regulations_actionsStringNoN/A Must be the alias of an existing segment, which will render actions non-countable when users are tagged with it.
regulations_countryCSV
String
NoN/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_keywordsCSV
String
NoN/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 NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
roadblock_campaignsCSV
Integer
NoN/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_zonesCSV
Integer
NoN/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)

XML Response

Hyperlink /servlet/control/api/advertisers/update?secret=(key)&id=123&name=ACME+Company


<success/>

JSON Response

Hyperlink /servlet/control/api/advertisers/update?secret=(key)&output=json&id=123&name=ACME+Company


{ "success" : true }