API Queries - Update Suggest

The update_keyword function allows you to change settings or the status of an existing brands. This function requires additional parameters. Although optional parameters are not all required, at least one must be included. Failing to include required parameters or at least one optional will result in an error response.

Additional Parameters

• keyword - Name of Keyword to update. (Required)
• folder - Name of the folder where the keyword is added. (Required)
• traffic_type - The traffic type, either "desktop", "mobile" or "all". (Required)
• my_bid- Your bid for the keyword. (Optional)
• daily_limit - Daily spend limit for the keyword. (Optional)
  
• target_url- The Target URL, including https:// (Optional, campaign will be moved to pending section for approval)
• channel - Suggest (Required)
• active- To Stop or Activate the keyword, use values 0 or 1, respectively. (Optional)
• geo_target - The Geo Target, either "all", "us", "uk", "ca", "au", "nz", "in", "br", "de", "fr", "nl", "it", or "es". (Required)
• freq_cap- Limit on number of visits per unique user in 24 hour period. Choose from "3", "6" or "12". (Optional)
• bl_subid- Adds subid to blacklist. (Optional)
• del_bl_subid- Removes blacklisted subid. (Optional)
• wl_subid- Adds subid to whitelist. (Optional)
• premium_bid- Premium bid amount for whitelisted subid. (Required)
• other_subid_traffic- Allow traffic from whitelisted subids plus all other subids associated with this campaign.
• 1 is ON and 0 is OFF. Default is 1 (on). (Optional, only approved campiagn can be enabled)
• del_wl_subid - Removes subid from whitelist. (Optional)
• include_coupon - Include Coupon traffic. "1" to include, "0" to exclude. (Optional)

Note: The traffic_type, channel and geo_target parameters are used to select the correct keyword and will not be changed. Make sure to URL encode all values, most importantly the target_url value.

Sample Query

<results>
<result Setting="MyBid" Success="$55.00" />
<result Setting="DailySpendLimit" Success="$5000.00" />
<result Setting="TargetUrl" Success="http://www.amazon.com" />
</results>

Error Responses:

Possible error responses for this function are:

• 401 - Multiple Sub ID actions not supported.
• 412 - Keyword is a required argument for this mode.
• 412 - Traffic Type is a required argument for this mode.
• 412 - Geo Target is a required argument for this mode.
• 412 - Premium Bid is a required argument for parameter Whitelist Subid.
• 413 - No changes were requested.
• 420 - Keyword not found.
• 420 - Subid ###### does not exist.
• 420 - Subid ###### is blacklisted. Please delete first before whitelisting.
• 420 - Subid ###### not in whitelist.
• 420 - Subid ###### not in blacklist.
• 420 - Subid ###### is whitelisted. Please delete first before blacklisting.
• 421 - Keyword may only contain letters, digits or spaces.
• 421 - Traffic Type may only be "all","mobile","desktop".
• 421 - Target URL entered is invalid.
• 421 - Frequency Cap for Keywords may only be "3","6","12".
• 422 - Negative keyword list must be comma separated, and keywords may only contain letters, digits and spaces.
• 423 - My Bid must contain digits and an optional decimal point only.
• 423 - Sorry, the entered bid is not valid. Bid should be entered in a valid format (2 decimal places).
• 423 - Sorry, the bid amount is outside the allowed range. My Bid should be no more than $100.
• 423 - Premium Bid must be numeric.
• 423 - Your Premium Bid must be less than or equal to $100.
• 423 - MyBid should be in range of $0.05 to $100
• 424 - Subid must be numeric.
• 424 - Daily Limit must contain digits and an optional decimal point only, or be left blank to have no limit set.
• 424 - Sorry, the Daily Limit amount is outside the allowed range. Limit must be no less than $10.00 and no greater than $10000.00.
• 424 - Subid invalid.
• 424 - Subid not blacklisted as it exceeds limit on campaign.
• 425 - Target URL is not in valid format.
• 429 - Geo Target is invalid.
• 429 - Other Subid Traffic may only be "1" or "0".
• 429 - Your Premium Bid does not meet the required bid for this Subid. Please increase your bid to at least $##.##.
• Other general errors, such as 200 - Internal Error or 300 - Username or password invalid.

For a complete list of error responses, see the Error Codes manual page.