Export (0) Print
Expand All

UpdateAdGroups REST Template

Updates the details of the specified ad groups.




The identifier of the campaign that contains the ad groups to update.

Request Components

The following specifies the HTTP method, supported content types, and base URI to use in your request.

  • HTTP method: PUT

  • Supported content types: XML and JSON

    • To use JSON, your request URL must include the “format=json” query string.

    • For enumeration types, you must use numeric values instead of the value name defined in the value set. For example, to specify the Content value defined in the AdDistribution value set, set the AdDistribution element of the AdGroup object to 2 instead of to Content.

    • All enumerations are zero-based, and increment by 1, except for the AdDistribution value set, which is one-based.

    • The key names that you use for the JSON members are the same as the elements of the XML objects shown in the examples below.

  • Production base URI: https://adcenterapi.microsoft.com/Api/Advertiser/v8/CampaignManagement/CampaignManagementServiceREST.svc

  • Sandbox base URI: Not available.

If the web browser or firewall does not support the PUT method, use the POST method and include the X-HTTP-Method-Override header. Set the X-HTTP-Method-Override header value to PUT.

Request Headers

The following are the headers to include in your request.




The application access token. This header is not used.


The account identifier. For more information, see Account and Customer Identifiers.


The customer identifier. For more information, see Account and Customer Identifiers.


The developer access token.


The user’s logon password.


The user’s logon user name.

Request Body

The following XML fragment shows the elements to use to update the ad groups. Specify only those elements that you are updating. For a description of each element and the header elements that your request must include, see UpdateAdGroupsRequest Message Object.

<UpdateAdGroupsRequest xmlns="http://schemas.datacontract.org/2004/07/HostedService.CampaignManagementService.Rest" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AdGroups xmlns:d2p1="https://adcenter.microsoft.com/v8">
        < d2p1:Month></d2p1:Month>
      <d2p1:Language i:nil="true" />
      <d2p1:PricingModel i:nil="true" />
      <d2p1:Status i:nil="true" />

Response Body

The response does not include a body. For a description of the TrackingId header element that the response includes, see UpdateAdGroupsResponse Message Object.


If an error occurs, the service returns one of the following HTTP error codes.




Bad request, which indicates that the request data contains an error. The response will contain either an ApiFaultDetail or AdApiFaultDetail object that identifies the error. For a list of possible error codes, see Campaign Management Error Codes and Common Error Codes.


Not authorized.


Not found.


Method not allowed, which indicates that the URI template is not correct.


Server error.

Community Additions

© 2014 Microsoft