BatchUpdateDocumentResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/google/main/json-schema/google-batch-update-document-response-schema.json",
  "title": "BatchUpdateDocumentResponse",
  "description": "Response message from a BatchUpdateDocument request.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-documents-api-openapi.yml#/components/schemas/BatchUpdateDocumentResponse",
  "properties": {
    "documentId": {
      "description": "The ID of the document to which the updates were applied to.",
      "type": "string"
    },
    "replies": {
      "description": "The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty.",
      "items": {
        "$ref": "#/$defs/Response"
      },
      "type": "array"
    },
    "writeControl": {
      "$ref": "#/$defs/WriteControl",
      "description": "The updated write control after applying the request."
    }
  },
  "type": "object",
  "$defs": {
    "CreateFooterResponse": {
      "description": "The result of creating a footer.",
      "properties": {
        "footerId": {
          "description": "The ID of the created footer.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "CreateFootnoteResponse": {
      "description": "The result of creating a footnote.",
      "properties": {
        "footnoteId": {
          "description": "The ID of the created footnote.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "CreateHeaderResponse": {
      "description": "The result of creating a header.",
      "properties": {
        "headerId": {
          "description": "The ID of the created header.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "CreateNamedRangeResponse": {
      "description": "The result of creating a named range.",
      "properties": {
        "namedRangeId": {
          "description": "The ID of the created named range.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "InsertInlineImageResponse": {
      "description": "The result of inserting an inline image.",
      "properties": {
        "objectId": {
          "description": "The ID of the created InlineObject.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "InsertInlineSheetsChartResponse": {
      "description": "The result of inserting an embedded Google Sheets chart.",
      "properties": {
        "objectId": {
          "description": "The object ID of the inserted chart.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "ReplaceAllTextResponse": {
      "description": "The result of replacing text.",
      "properties": {
        "occurrencesChanged": {
          "description": "The number of occurrences changed by replacing all text.",
          "format": "int32",
          "type": "integer"
        }
      },
      "type": "object"
    },
    "Response": {
      "description": "A single response from an update.",
      "properties": {
        "createFooter": {
          "$ref": "#/$defs/CreateFooterResponse",
          "description": "The result of creating a footer."
        },
        "createFootnote": {
          "$ref": "#/$defs/CreateFootnoteResponse",
          "description": "The result of creating a footnote."
        },
        "createHeader": {
          "$ref": "#/$defs/CreateHeaderResponse",
          "description": "The result of creating a header."
        },
        "createNamedRange": {
          "$ref": "#/$defs/CreateNamedRangeResponse",
          "description": "The result of creating a named range."
        },
        "insertInlineImage": {
          "$ref": "#/$defs/InsertInlineImageResponse",
          "description": "The result of inserting an inline image."
        },
        "insertInlineSheetsChart": {
          "$ref": "#/$defs/InsertInlineSheetsChartResponse",
          "description": "The result of inserting an inline Google Sheets chart."
        },
        "replaceAllText": {
          "$ref": "#/$defs/ReplaceAllTextResponse",
          "description": "The result of replacing text."
        }
      },
      "type": "object"
    },
    "WriteControl": {
      "description": "Provides control over how write requests are executed.",
      "properties": {
        "requiredRevisionId": {
          "description": "The optional revision ID of the document the write request is applied to. If this is not the latest revision of the document, the request is not processed and returns a 400 bad request error. When a required revision ID is returned in a response, it indicates the revision ID of the document after the request was applied.",
          "type": "string"
        },
        "targetRevisionId": {
          "description": "The optional target revision ID of the document the write request is applied to. If collaborator changes have occurred after the document was read using the API, the changes produced by this write request are applied against the collaborator changes. This results in a new revision of the document that incorporates both the collaborator changes and the changes in the request, with the Docs server resolving conflicting changes. When using target revision ID, the API client can be thought of as another collaborator of the document. The target revision ID can only be used to write to recent versions of a document. If the target revision is too far behind the latest revision, the request is not processed and returns a 400 bad request error. The request should be tried again after retrieving the latest version of the document. Usually a revision ID remains valid for use as a target revision for several minutes after it's read, but for frequently edited documents this window might be shorter.",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}