- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- CustomerUserAccessInvitationOperation
- MutateCustomerUserAccessInvitationResult
- Try it!
Creates or removes an access invitation.
List of thrown errors: AccessInvitationError AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError
HTTP request
POST https://googleads.googleapis.com/v17/customers/{customerId}/customerUserAccessInvitations:mutate
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
customerId |
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 ( |
Fields | |
---|---|
operation |
Required. The operation to perform on the access invitation |
Response body
Response message for access invitation mutate.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"result": {
object ( |
Fields | |
---|---|
result |
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 |
Fields | |
---|---|
Union field operation . The mutate operation operation can be only one of the following: |
|
create |
Create operation: No resource name is expected for the new access invitation. |
remove |
Remove operation: A resource name for the revoke invitation is expected, in this format:
|
MutateCustomerUserAccessInvitationResult
The result for the access invitation mutate.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resourceName |
Returned for successful operations. |