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.customerManagerLinks.mutate

Creates or updates customer manager links. Operation statuses are returned.

List of thrown errors: AuthenticationError AuthorizationError DatabaseError FieldError FieldMaskError HeaderError InternalError ManagerLinkError MutateError QuotaError RequestError

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer whose customer manager links are being modified.

Request body

The request body contains data with the following structure:

JSON representation
{
  "operations": [
    {
      object (CustomerManagerLinkOperation)
    }
  ],
  "validateOnly": boolean
}
Fields
operations[]

object (CustomerManagerLinkOperation)

Required. The list of operations to perform on individual customer manager links.

validateOnly

boolean

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

Response body

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

Response message for a CustomerManagerLink mutate.

JSON representation
{
  "results": [
    {
      object (MutateCustomerManagerLinkResult)
    }
  ]
}
Fields
results[]

object (MutateCustomerManagerLinkResult)

A result that identifies the resource affected by the mutate request.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

CustomerManagerLinkOperation

Updates the status of a CustomerManagerLink. The following actions are possible: 1. Update operation with status ACTIVE accepts a pending invitation. 2. Update operation with status REFUSED declines a pending invitation. 3. Update operation with status INACTIVE terminates link to manager.

JSON representation
{
  "updateMask": string,
  "update": {
    object (CustomerManagerLink)
  }
}
Fields
updateMask

string (FieldMask format)

FieldMask that determines which resource fields are modified in an update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

update

object (CustomerManagerLink)

Update operation: The link is expected to have a valid resource name.

MutateCustomerManagerLinkResult

The result for the customer manager link mutate.

JSON representation
{
  "resourceName": string
}
Fields
resourceName

string

Returned for successful operations.