sections.setOddEvenHeadersFooters

Enable or disable odd/even header-footer mode in document settings.

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

Summary

Enable or disable odd/even header-footer mode in document settings.

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

Expected result

Returns a DocumentMutationResult receipt; reports NO_OP if the odd/even setting already matches.

Input fields

Field	Type	Required	Description
enabled	boolean	yes

Example request

{
  "enabled": true
}

Output fields

Variant 1 (success=true)

Field	Type	Required	Description
success	true	yes	Constant: true

Variant 2 (success=false)

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

Example response

{
  "success": true
}

Pre-apply throws

• INVALID_INPUT
• CAPABILITY_UNAVAILABLE
• INTERNAL_ERROR

Non-applied failure codes

• NO_OP
• CAPABILITY_UNAVAILABLE

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "enabled": {
      "type": "boolean"
    }
  },
  "required": [
    "enabled"
  ],
  "type": "object"
}

Raw output schema

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "const": true
        }
      },
      "required": [
        "success"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "enum": [
                "NO_OP",
                "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": {
    "success": {
      "const": true
    }
  },
  "required": [
    "success"
  ],
  "type": "object"
}

Raw failure schema

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