sections.setPageSetup

Set page size/orientation properties for a section.

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

Summary

Set page size/orientation properties for a section.

• Operation ID: sections.setPageSetup
• API member path: editor.doc.sections.setPageSetup(...)
• Mutates document: yes
• Idempotency: conditional
• Supports tracked mode: no
• Supports dry run: yes
• Deterministic target resolution: yes

Expected result

Returns a SectionMutationResult receipt; reports NO_OP if page size and orientation already match the requested values.

Input fields

Variant 1

No fields.

Variant 2

No fields.

Variant 3

No fields.

Variant 4

No fields.

Example request

{
  "height": 12.5,
  "orientation": "portrait",
  "target": {
    "kind": "section",
    "sectionId": "example"
  },
  "width": 12.5
}

Output fields

Variant 1 (section.kind=“section”)

Field	Type	Required	Description
section	SectionAddress	yes	SectionAddress
section.kind	"section"	yes	Constant: "section"
section.sectionId	string	yes
success	true	yes	Constant: true

Variant 2 (success=false)

Field	Type	Required	Description
failure	object	yes
failure.code	enum	yes	"NO_OP", "INVALID_TARGET", "CAPABILITY_UNAVAILABLE"
failure.details	any	no
failure.message	string	yes
success	false	yes	Constant: false

Example response

{
  "section": {
    "kind": "section",
    "sectionId": "example"
  },
  "success": true
}

Pre-apply throws

• TARGET_NOT_FOUND
• INVALID_TARGET
• INVALID_INPUT
• CAPABILITY_UNAVAILABLE
• INTERNAL_ERROR

Non-applied failure codes

• NO_OP
• INVALID_TARGET
• CAPABILITY_UNAVAILABLE

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "oneOf": [
    {
      "required": [
        "target",
        "width"
      ]
    },
    {
      "required": [
        "target",
        "height"
      ]
    },
    {
      "required": [
        "target",
        "orientation"
      ]
    },
    {
      "required": [
        "target",
        "paperSize"
      ]
    }
  ],
  "properties": {
    "height": {
      "minimum": 0,
      "type": "number"
    },
    "orientation": {
      "enum": [
        "portrait",
        "landscape"
      ]
    },
    "paperSize": {
      "minLength": 1,
      "type": "string"
    },
    "target": {
      "$ref": "#/$defs/SectionAddress"
    },
    "width": {
      "minimum": 0,
      "type": "number"
    }
  },
  "required": [
    "target"
  ],
  "type": "object"
}

Raw output schema

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

Raw success schema

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

Raw failure schema

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