GoogleAdsGoogleadsV25Services__MutateCustomerClientLinkRequest

{
  "$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-client-link-request-schema.json",
  "title": "GoogleAdsGoogleadsV25Services__MutateCustomerClientLinkRequest",
  "description": "Request message for CustomerClientLinkService.MutateCustomerClientLink.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-customers-customerclientlinks-api-openapi.yml#/components/schemas/GoogleAdsGoogleadsV25Services__MutateCustomerClientLinkRequest",
  "type": "object",
  "properties": {
    "operation": {
      "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__CustomerClientLinkOperation",
      "description": "Required. The operation to perform on the individual CustomerClientLink."
    },
    "validateOnly": {
      "description": "If true, the request is validated but not executed. Only errors are returned, not results.",
      "type": "boolean"
    }
  },
  "$defs": {
    "GoogleAdsGoogleadsV25Resources__CustomerClientLink": {
      "type": "object",
      "properties": {
        "managerLinkId": {
          "format": "int64",
          "type": "string",
          "description": "Output only. This is uniquely identifies a customer client link. Read only."
        },
        "hidden": {
          "type": "boolean",
          "description": "The visibility of the link. Users can choose whether or not to see hidden links in the Google Ads UI. Default value is false"
        },
        "clientCustomer": {
          "type": "string",
          "description": "Immutable. The client customer linked to this customer."
        },
        "status": {
          "description": "This is the status of the link between client and manager.",
          "type": "string",
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "Indicates current in-effect relationship",
            "Indicates terminated relationship",
            "Indicates relationship has been requested by manager, but the client hasn't accepted yet.",
            "Relationship was requested by the manager, but the client has refused.",
            "Indicates relationship has been requested by manager, but manager canceled it."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "ACTIVE",
            "INACTIVE",
            "PENDING",
            "REFUSED",
            "CANCELED"
          ]
        },
        "resourceName": {
          "description": "Immutable. Name of the resource. CustomerClientLink resource names have the form: `customers/{customer_id}/customerClientLinks/{client_customer_id}~{manager_link_id}`",
          "type": "string"
        }
      },
      "description": "Represents customer client link relationship."
    },
    "GoogleAdsGoogleadsV25Services__CustomerClientLinkOperation": {
      "type": "object",
      "properties": {
        "updateMask": {
          "format": "google-fieldmask",
          "type": "string",
          "description": "FieldMask that determines which resource fields are modified in an update."
        },
        "create": {
          "description": "Create operation: No resource name is expected for the new link.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__CustomerClientLink"
        },
        "update": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__CustomerClientLink",
          "description": "Update operation: The link is expected to have a valid resource name."
        }
      },
      "description": "A single operation (create, update) on a CustomerClientLink."
    }
  }
}