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

Creates or removes an access invitation.

List of thrown errors: AccessInvitationError AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer whose access invitation is being modified.

Request body

The request body contains data with the following structure:

JSON representation
{
  "operation": {
    object (CustomerUserAccessInvitationOperation)
  }
}
Fields
operation

object (CustomerUserAccessInvitationOperation)

Required. The operation to perform on the access invitation

Response body

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

Response message for access invitation mutate.

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

object (MutateCustomerUserAccessInvitationResult)

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.

CustomerUserAccessInvitationOperation

A single operation (create or remove) on customer user access invitation.

JSON representation
{

  // Union field operation can be only one of the following:
  "create": {
    object (CustomerUserAccessInvitation)
  },
  "remove": string
  // End of list of possible types for union field operation.
}
Fields
Union field operation. The mutate operation operation can be only one of the following:
create

object (CustomerUserAccessInvitation)

Create operation: No resource name is expected for the new access invitation.

remove

string

Remove operation: A resource name for the revoke invitation is expected, in this format:

customers/{customerId}/customerUserAccessInvitations/{invitationId}

MutateCustomerUserAccessInvitationResult

The result for the access invitation mutate.

JSON representation
{
  "resourceName": string
}
Fields
resourceName

string

Returned for successful operations.