Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Method: customers.mutate

Updates a customer. Operation statuses are returned.

List of thrown errors: AuthenticationError AuthorizationError DatabaseError FieldMaskError HeaderError InternalError QuotaError RequestError UrlFieldError

HTTP request

POST https://googleads.googleapis.com/v7/customers/{customerId}:mutate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer being modified.

Request body

The request body contains data with the following structure:

JSON representation
{
  "operation": {
    object (CustomerOperation)
  },
  "validateOnly": boolean,
  "responseContentType": enum (ResponseContentType)
}
Fields
operation

object (CustomerOperation)

Required. The operation to perform on the customer

validateOnly

boolean

If true, the request is validated but not executed. Only errors are returned, not results.

responseContentType

enum (ResponseContentType)

The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation.

Response body

If successful, the response body contains data with the following structure:

Response message for customer mutate.

JSON representation
{
  "result": {
    object (MutateCustomerResult)
  }
}
Fields
result

object (MutateCustomerResult)

Result for the mutate.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.