GoogleAdsGoogleadsV25Services__MutateCustomerUserAccessInvitationRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/google-ads/json-schema/google-ads-google-ads-googleads-v25-services-mutate-customer-user-access-invitation-request-schema.json",
  "title": "GoogleAdsGoogleadsV25Services__MutateCustomerUserAccessInvitationRequest",
  "description": "Request message for CustomerUserAccessInvitationService.MutateCustomerUserAccessInvitation",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-customers-customeruseraccessinvitations-api-openapi.yml#/components/schemas/GoogleAdsGoogleadsV25Services__MutateCustomerUserAccessInvitationRequest",
  "type": "object",
  "properties": {
    "operation": {
      "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__CustomerUserAccessInvitationOperation",
      "description": "Required. The operation to perform on the access invitation"
    }
  },
  "$defs": {
    "GoogleAdsGoogleadsV25Resources__CustomerUserAccessInvitation": {
      "description": "Represent an invitation to a new user on this customer account.",
      "type": "object",
      "properties": {
        "invitationStatus": {
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "The initial state of an invitation, before being acted upon by anyone.",
            "Invitation process was terminated by the email recipient. No new user was created.",
            "Invitation URLs expired without being acted upon. No new user can be created. Invitations expire 20 days after creation."
          ],
          "type": "string",
          "description": "Output only. Invitation status of the user.",
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "PENDING",
            "DECLINED",
            "EXPIRED"
          ]
        },
        "resourceName": {
          "type": "string",
          "description": "Immutable. Name of the resource. Resource names have the form: `customers/{customer_id}/customerUserAccessInvitations/{invitation_id}`"
        },
        "invitationId": {
          "format": "int64",
          "description": "Output only. The ID of the invitation. This field is read-only.",
          "type": "string"
        },
        "emailAddress": {
          "description": "Immutable. Email address the invitation was sent to. This can differ from the email address of the account that accepts the invite.",
          "type": "string"
        },
        "creationDateTime": {
          "type": "string",
          "description": "Output only. Time invitation was created. This field is read-only. The format is \"YYYY-MM-DD HH:MM:SS\". Examples: \"2018-03-05 09:15:00\" or \"2018-02-01 14:34:30\""
        },
        "accessRole": {
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "Owns its account and can control the addition of other users.",
            "Can modify campaigns, but can't affect other users.",
            "Can view campaigns and account changes, but cannot make edits.",
            "Role for \\\"email only\\\" access. Represents an email recipient rather than a true User entity."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "ADMIN",
            "STANDARD",
            "READ_ONLY",
            "EMAIL_ONLY"
          ],
          "description": "Immutable. Access role of the user.",
          "type": "string"
        }
      }
    },
    "GoogleAdsGoogleadsV25Services__CustomerUserAccessInvitationOperation": {
      "description": "A single operation (create or remove) on customer user access invitation.",
      "type": "object",
      "properties": {
        "create": {
          "description": "Create operation: No resource name is expected for the new access invitation.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__CustomerUserAccessInvitation"
        },
        "remove": {
          "description": "Remove operation: A resource name for the revoke invitation is expected, in this format: `customers/{customer_id}/customerUserAccessInvitations/{invitation_id}`",
          "type": "string"
        }
      }
    }
  }
}