> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superdoc.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# footnotes.configure

> Configure numbering and placement for footnotes or endnotes.

## Summary

Configure numbering and placement for footnotes or endnotes.

* Operation ID: `footnotes.configure`
* API member path: `editor.doc.footnotes.configure(...)`
* Mutates document: `yes`
* Idempotency: `idempotent`
* Supports tracked mode: `no`
* Supports dry run: `yes`
* Deterministic target resolution: `yes`

## Expected result

Returns a FootnoteConfigResult indicating success or a failure.

## Input fields

| Field | Type | Required | Description |
| - | - | - | - |
| `numbering` | object | no | |
| `numbering.format` | enum | no | `"decimal"`, `"lowerRoman"`, `"upperRoman"`, `"lowerLetter"`, `"upperLetter"`, `"symbol"` |
| `numbering.position` | enum | no | `"pageBottom"`, `"beneathText"`, `"sectionEnd"`, `"documentEnd"` |
| `numbering.restartPolicy` | enum | no | `"continuous"`, `"eachSection"`, `"eachPage"` |
| `numbering.start` | integer | no | |
| `scope` | object(kind="document") \| object(kind="section") | yes | One of: object(kind="document"), object(kind="section") |
| `type` | enum | yes | `"footnote"`, `"endnote"` |

### Example request

```json theme={null}
{
  "numbering": {
    "format": "decimal",
    "start": 0
  },
  "scope": {
    "kind": "document"
  },
  "type": "footnote"
}
```

## 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` | string | yes | |
| `failure.details` | any | no | |
| `failure.message` | string | yes | |
| `success` | `false` | yes | Constant: `false` |

### Example response

```json theme={null}
{
  "success": true
}
```

## Pre-apply throws

* `TARGET_NOT_FOUND`
* `INVALID_TARGET`
* `INVALID_INPUT`
* `CAPABILITY_UNAVAILABLE`

## Non-applied failure codes

* None

## Raw schemas

> [accordion] Raw input schema
>
> ```json theme={null}
> {
>   "additionalProperties": false,
>   "properties": {
>     "numbering": {
>       "additionalProperties": false,
>       "properties": {
>         "format": {
>           "enum": [
>             "decimal",
>             "lowerRoman",
>             "upperRoman",
>             "lowerLetter",
>             "upperLetter",
>             "symbol"
>           ]
>         },
>         "position": {
>           "enum": [
>             "pageBottom",
>             "beneathText",
>             "sectionEnd",
>             "documentEnd"
>           ]
>         },
>         "restartPolicy": {
>           "enum": [
>             "continuous",
>             "eachSection",
>             "eachPage"
>           ]
>         },
>         "start": {
>           "type": "integer"
>         }
>       },
>       "type": "object"
>     },
>     "scope": {
>       "oneOf": [
>         {
>           "additionalProperties": false,
>           "properties": {
>             "kind": {
>               "const": "document"
>             }
>           },
>           "required": [
>             "kind"
>           ],
>           "type": "object"
>         },
>         {
>           "additionalProperties": false,
>           "properties": {
>             "kind": {
>               "const": "section"
>             },
>             "sectionId": {
>               "type": "string"
>             }
>           },
>           "required": [
>             "kind",
>             "sectionId"
>           ],
>           "type": "object"
>         }
>       ]
>     },
>     "type": {
>       "enum": [
>         "footnote",
>         "endnote"
>       ]
>     }
>   },
>   "required": [
>     "type",
>     "scope"
>   ],
>   "type": "object"
> }
> ```

> [accordion] Raw output schema
>
> ```json theme={null}
> {
>   "oneOf": [
>     {
>       "additionalProperties": false,
>       "properties": {
>         "success": {
>           "const": true
>         }
>       },
>       "required": [
>         "success"
>       ],
>       "type": "object"
>     },
>     {
>       "additionalProperties": false,
>       "properties": {
>         "failure": {
>           "additionalProperties": false,
>           "properties": {
>             "code": {
>               "type": "string"
>             },
>             "details": {},
>             "message": {
>               "type": "string"
>             }
>           },
>           "required": [
>             "code",
>             "message"
>           ],
>           "type": "object"
>         },
>         "success": {
>           "const": false
>         }
>       },
>       "required": [
>         "success",
>         "failure"
>       ],
>       "type": "object"
>     }
>   ]
> }
> ```

> [accordion] Raw success schema
>
> ```json theme={null}
> {
>   "additionalProperties": false,
>   "properties": {
>     "success": {
>       "const": true
>     }
>   },
>   "required": [
>     "success"
>   ],
>   "type": "object"
> }
> ```

> [accordion] Raw failure schema
>
> ```json theme={null}
> {
>   "additionalProperties": false,
>   "properties": {
>     "failure": {
>       "additionalProperties": false,
>       "properties": {
>         "code": {
>           "type": "string"
>         },
>         "details": {},
>         "message": {
>           "type": "string"
>         }
>       },
>       "required": [
>         "code",
>         "message"
>       ],
>       "type": "object"
>     },
>     "success": {
>       "const": false
>     }
>   },
>   "required": [
>     "success",
>     "failure"
>   ],
>   "type": "object"
> }
> ```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.