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

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

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

## Request

- Base URL: `https://searchads360.googleapis.com`
- URL: `https://searchads360.googleapis.com/v23/customers/{customersId}/keywordPlans: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/keywordPlans:mutate/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates, updates, or removes keyword plans. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [KeywordPlanError]() [MutateError]() [NewResourceCreationError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]() [StringLengthError]()

## Path parameters

- `customersId` string, required

## Request body

- GoogleAdsSearchads360V23ServicesMutateKeywordPlansRequest: Request message for KeywordPlanService.MutateKeywordPlans.
  - `operations` GoogleAdsSearchads360V23ServicesKeywordPlanOperation[]: Required. The list of operations to perform on individual keyword plans.
    - `create` GoogleAdsSearchads360V23ResourcesKeywordPlan: A Keyword Planner plan. Max number of saved keyword plans: 10000. It's possible to remove plans if limit is reached.
      - `forecastPeriod` GoogleAdsSearchads360V23ResourcesKeywordPlanForecastPeriod: The forecasting period associated with the keyword plan.
        - `dateInterval` 'UNSPECIFIED' | 'UNKNOWN' | 'NEXT_WEEK' | 'NEXT_MONTH' | 'NEXT_QUARTER': A future date range relative to the current date used for forecasting.
        - `dateRange` GoogleAdsSearchads360V23CommonDateRange: A date range.
          - `endDate` string: The end date, in yyyy-mm-dd format. This date is inclusive.
          - `startDate` string: The start date, in yyyy-mm-dd format. This date is inclusive.
      - `id` string, int64: Output only. The ID of the keyword plan.
      - `name` string: The name of the keyword plan. This field is required and should not be empty when creating new keyword plans.
      - `resourceName` string: Immutable. The resource name of the Keyword Planner plan. KeywordPlan resource names have the form: `customers/{customer_id}/keywordPlans/{kp_plan_id}`
    - `remove` string: Remove operation: A resource name for the removed keyword plan is expected in this format: `customers/{customer_id}/keywordPlans/{keyword_plan_id}`
    - `update` GoogleAdsSearchads360V23ResourcesKeywordPlan: A Keyword Planner plan. Max number of saved keyword plans: 10000. It's possible to remove plans if limit is reached.
      - `forecastPeriod` GoogleAdsSearchads360V23ResourcesKeywordPlanForecastPeriod: The forecasting period associated with the keyword plan.
        - `dateInterval` 'UNSPECIFIED' | 'UNKNOWN' | 'NEXT_WEEK' | 'NEXT_MONTH' | 'NEXT_QUARTER': A future date range relative to the current date used for forecasting.
        - `dateRange` GoogleAdsSearchads360V23CommonDateRange: A date range.
          - `endDate` string: The end date, in yyyy-mm-dd format. This date is inclusive.
          - `startDate` string: The start date, in yyyy-mm-dd format. This date is inclusive.
      - `id` string, int64: Output only. The ID of the keyword plan.
      - `name` string: The name of the keyword plan. This field is required and should not be empty when creating new keyword plans.
      - `resourceName` string: Immutable. The resource name of the Keyword Planner plan. KeywordPlan resource names have the form: `customers/{customer_id}/keywordPlans/{kp_plan_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

- GoogleAdsSearchads360V23ServicesMutateKeywordPlansResponse: Response message for a keyword plan 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` GoogleAdsSearchads360V23ServicesMutateKeywordPlansResult[]: All results for the mutate.
    - `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)