Skip to main content
Alpha: Document API is currently alpha and subject to breaking changes.

​
Summary

Create a section break at the target location with optional initial section properties.
  • Operation ID: create.sectionBreak
  • API member path: editor.doc.create.sectionBreak(...)
  • Mutates document: yes
  • Idempotency: non-idempotent
  • Supports tracked mode: no
  • Supports dry run: yes
  • Deterministic target resolution: yes

​
Expected result

Returns a CreateSectionBreakResult with the new section break position and section address.

​
Input fields

FieldTypeRequiredDescription
atobject(kind=“documentStart”) \object(kind=“documentEnd”) \object(kind=“before”) \object(kind=“after”)noOne of: object(kind=“documentStart”), object(kind=“documentEnd”), object(kind=“before”), object(kind=“after”)
breakTypeenumno"continuous", "nextPage", "evenPage", "oddPage"
headerFooterMarginsobjectno
pageMarginsobjectno

​
Example request

{
  "at": {
    "kind": "documentStart"
  },
  "breakType": "continuous"
}

​
Output fields

No fields.

​
Example response

{
  "breakParagraph": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "paragraph"
  },
  "section": {
    "kind": "section",
    "sectionId": "example"
  },
  "success": true
}

​
Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • AMBIGUOUS_TARGET
  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE
  • INTERNAL_ERROR

​
Non-applied failure codes

  • INVALID_TARGET
  • CAPABILITY_UNAVAILABLE

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "at": {
      "oneOf": [
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "documentStart"
            }
          },
          "required": [
            "kind"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "documentEnd"
            }
          },
          "required": [
            "kind"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "before"
            },
            "target": {
              "$ref": "#/$defs/BlockNodeAddress"
            }
          },
          "required": [
            "kind",
            "target"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "kind": {
              "const": "after"
            },
            "target": {
              "$ref": "#/$defs/BlockNodeAddress"
            }
          },
          "required": [
            "kind",
            "target"
          ],
          "type": "object"
        }
      ]
    },
    "breakType": {
      "enum": [
        "continuous",
        "nextPage",
        "evenPage",
        "oddPage"
      ]
    },
    "headerFooterMargins": {
      "additionalProperties": false,
      "properties": {
        "footer": {
          "minimum": 0,
          "type": "number"
        },
        "header": {
          "minimum": 0,
          "type": "number"
        }
      },
      "type": "object"
    },
    "pageMargins": {
      "additionalProperties": false,
      "properties": {
        "bottom": {
          "minimum": 0,
          "type": "number"
        },
        "gutter": {
          "minimum": 0,
          "type": "number"
        },
        "left": {
          "minimum": 0,
          "type": "number"
        },
        "right": {
          "minimum": 0,
          "type": "number"
        },
        "top": {
          "minimum": 0,
          "type": "number"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "breakParagraph": {
          "$ref": "#/$defs/BlockNodeAddress"
        },
        "section": {
          "$ref": "#/$defs/SectionAddress"
        },
        "success": {
          "const": true
        }
      },
      "required": [
        "success",
        "section"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "enum": [
                "INVALID_TARGET",
                "CAPABILITY_UNAVAILABLE"
              ]
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

{
  "additionalProperties": false,
  "properties": {
    "breakParagraph": {
      "$ref": "#/$defs/BlockNodeAddress"
    },
    "section": {
      "$ref": "#/$defs/SectionAddress"
    },
    "success": {
      "const": true
    }
  },
  "required": [
    "success",
    "section"
  ],
  "type": "object"
}

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "enum": [
            "INVALID_TARGET",
            "CAPABILITY_UNAVAILABLE"
          ]
        },
        "details": {},
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "type": "object"
}