Update an Ad Group
Updates an ad group with an ad group identifier.
URL
PUT https://api.searchads.apple.com/api/v5/campaigns/{campaignId}/adgroups/{adgroupId}Path Parameters
| Name | Type | Description |
|---|---|---|
adgroupId Required | int64 | The unique identifier for the ad group. |
campaignId Required | int64 | The unique identifier for the campaign. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | AdGroupResponse | If the call succeeds, the API returns the AdGroup object in the response payload with an HTTP status code of |
| 400 | Bad Request Content-Type: application/json | ApiErrorResponse | An invalid query or missing required parameters. |
| 401 | Unauthorized Content-Type: application/json | ApiErrorResponse | An unauthenticated call fails to get the requested response. |
| 403 | Forbidden Content-Type: application/json | ApiErrorResponse | Insufficient rights to the resource. |
| 404 | Not Found Content-Type: application/json | ApiErrorResponse | The API can’t locate the resource. |
| 429 | Content-Type: application/json | ApiErrorResponse | The API calls exceed rate-limit thresholds. See the Rate Limits subsection of Calling the Apple Ads API. |
| 500 | Internal Server Error Content-Type: application/json | ApiErrorResponse | The Apple Ads server is temporarily down or unreachable. The request may be valid, but you need to retry it later. |
Discussion
To update ad groups, use the associated campaignId and adgroupId in the resource path.
In the request, specify TargetingDimensions and apply it to ad groups. If you’re not updating TargetingDimensions, don’t include them in the payload. Use partial updates as necessary. For more information, see the Use Partial Updates section of Using Apple Ads API Functionality.
Payload example: Update an ad group with targeting
Payload example: Update an ad group without targeting
Payload example: Update an ad group CPA goal
Payload example: Update an ad group Search March setting
Only the name field can be updated in automated ad groups.
defaultBidAmountcannot be changed to a non-zero/non-null value.cpaGoalcannot be set to a non-null value.biddingStrategyis read-only.automatedKeywordsOptIncan be toggled true/false.automatedKeywordsRequiredis read-only.
Payload example: Update an ad group default bid amount
Only the name field can be updated in automated ad groups.
defaultBidAmountcannot be changed to a non-zero/non-null value.cpaGoalcannot be set to a non-null value.automatedKeywordsOptIncan be toggled true/false.biddingStrategyis read-only.automatedKeywordsRequiredis read-only.
HTTP Body
The request body that includes the details of the ad group and campaign.