---
title: "POST /v23/customers/{customersId}/keywordPlanAdGroups:mutate"
method: POST
path: "/v23/customers/{customersId}/keywordPlanAdGroups:mutate"
tags: ["customers"]
---

# POST /v23/customers/{customersId}/keywordPlanAdGroups:mutate

`POST /v23/customers/{customersId}/keywordPlanAdGroups:mutate`

## Request

- Base URL: `https://searchads360.googleapis.com`
- URL: `https://searchads360.googleapis.com/v23/customers/{customersId}/keywordPlanAdGroups:mutate`
- Auth: OAuth 2 and OAuth 2
  - Implicit: `https://accounts.google.com/o/oauth2/auth`
  - Scopes: `https://www.googleapis.com/auth/doubleclicksearch`
  - Authorization code: `https://accounts.google.com/o/oauth2/auth`
  - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/doubleclicksearch`
- TypeScript: <https://skmtc.dev/google/apis/searchads360/docs/v23/customers/:customersId/keywordPlanAdGroups:mutate/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates, updates, or removes Keyword Plan ad groups. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [KeywordPlanAdGroupError]() [KeywordPlanError]() [MutateError]() [NewResourceCreationError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()

## Path parameters

- `customersId` string, required

## Request body

- GoogleAdsSearchads360V23ServicesMutateKeywordPlanAdGroupsRequest: Request message for KeywordPlanAdGroupService.MutateKeywordPlanAdGroups.
  - `operations` GoogleAdsSearchads360V23ServicesKeywordPlanAdGroupOperation[]: Required. The list of operations to perform on individual Keyword Plan ad groups.
    - `create` GoogleAdsSearchads360V23ResourcesKeywordPlanAdGroup: A Keyword Planner ad group. Max number of keyword plan ad groups per plan: 200.
      - `cpcBidMicros` string, int64: A default ad group max cpc bid in micros in account currency for all biddable keywords under the keyword plan ad group. If not set, will inherit from parent campaign.
      - `id` string, int64: Output only. The ID of the keyword plan ad group.
      - `keywordPlanCampaign` string: The keyword plan campaign to which this ad group belongs.
      - `name` string: The name of the keyword plan ad group. This field is required and should not be empty when creating keyword plan ad group.
      - `resourceName` string: Immutable. The resource name of the Keyword Planner ad group. KeywordPlanAdGroup resource names have the form: `customers/{customer_id}/keywordPlanAdGroups/{kp_ad_group_id}`
    - `remove` string: Remove operation: A resource name for the removed Keyword Plan ad group is expected, in this format: `customers/{customer_id}/keywordPlanAdGroups/{kp_ad_group_id}`
    - `update` GoogleAdsSearchads360V23ResourcesKeywordPlanAdGroup: A Keyword Planner ad group. Max number of keyword plan ad groups per plan: 200.
      - `cpcBidMicros` string, int64: A default ad group max cpc bid in micros in account currency for all biddable keywords under the keyword plan ad group. If not set, will inherit from parent campaign.
      - `id` string, int64: Output only. The ID of the keyword plan ad group.
      - `keywordPlanCampaign` string: The keyword plan campaign to which this ad group belongs.
      - `name` string: The name of the keyword plan ad group. This field is required and should not be empty when creating keyword plan ad group.
      - `resourceName` string: Immutable. The resource name of the Keyword Planner ad group. KeywordPlanAdGroup resource names have the form: `customers/{customer_id}/keywordPlanAdGroups/{kp_ad_group_id}`
    - `updateMask` string, google-fieldmask: The FieldMask that determines which resource fields are modified in an update.
  - `partialFailure` boolean: If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
  - `validateOnly` boolean: If true, the request is validated but not executed. Only errors are returned, not results.

## Response `200`

Successful response

- GoogleAdsSearchads360V23ServicesMutateKeywordPlanAdGroupsResponse: Response message for a Keyword Plan ad group mutate.
  - `partialFailureError` GoogleRpcStatus: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
    - `code` integer: The status code, which should be an enum value of google.rpc.Code.
    - `details` object[]: A list of messages that carry the error details. There is a common set of message types for APIs to use.
    - `message` string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  - `results` GoogleAdsSearchads360V23ServicesMutateKeywordPlanAdGroupResult[]: All results for the mutate. The order of the results is determined by the order of the keywords in the original request.
    - `resourceName` string: Returned for successful operations.

---

[API](https://skmtc.dev/google/apis/searchads360.md) - [All operations](https://skmtc.dev/google/apis/searchads360/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/searchads360/revisions/4a4511f84b18?raw)