> ## Documentation Index
> Fetch the complete documentation index at: https://superdoc-caio-pizzol-docs-ai-core-preset.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# footnotes.remove

> Remove a footnote or endnote from the document.

## Summary

Remove a footnote or endnote from the document.

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

## Expected result

Returns a FootnoteMutationResult indicating success or a failure.

## Input fields

| Field               | Type                  | Required | Description            |
| ------------------- | --------------------- | -------- | ---------------------- |
| `target`            | object(kind="entity") | yes      |                        |
| `target.entityType` | `"footnote"`          | yes      | Constant: `"footnote"` |
| `target.kind`       | `"entity"`            | yes      | Constant: `"entity"`   |
| `target.noteId`     | string                | yes      |                        |

### Example request

```json theme={null}
{
  "target": {
    "entityType": "footnote",
    "kind": "entity",
    "noteId": "example"
  }
}
```

## Output fields

### Variant 1 (success=true)

| Field                 | Type                  | Required | Description            |
| --------------------- | --------------------- | -------- | ---------------------- |
| `footnote`            | object(kind="entity") | yes      |                        |
| `footnote.entityType` | `"footnote"`          | yes      | Constant: `"footnote"` |
| `footnote.kind`       | `"entity"`            | yes      | Constant: `"entity"`   |
| `footnote.noteId`     | string                | yes      |                        |
| `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}
{
  "footnote": {
    "entityType": "footnote",
    "kind": "entity",
    "noteId": "example"
  },
  "success": true
}
```

## Pre-apply throws

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

## Non-applied failure codes

* None

## Raw schemas

<Accordion title="Raw input schema">
  ```json theme={null}
  {
    "additionalProperties": false,
    "properties": {
      "target": {
        "additionalProperties": false,
        "properties": {
          "entityType": {
            "const": "footnote"
          },
          "kind": {
            "const": "entity"
          },
          "noteId": {
            "type": "string"
          }
        },
        "required": [
          "kind",
          "entityType",
          "noteId"
        ],
        "type": "object"
      }
    },
    "required": [
      "target"
    ],
    "type": "object"
  }
  ```
</Accordion>

<Accordion title="Raw output schema">
  ```json theme={null}
  {
    "oneOf": [
      {
        "additionalProperties": false,
        "properties": {
          "footnote": {
            "additionalProperties": false,
            "properties": {
              "entityType": {
                "const": "footnote"
              },
              "kind": {
                "const": "entity"
              },
              "noteId": {
                "type": "string"
              }
            },
            "required": [
              "kind",
              "entityType",
              "noteId"
            ],
            "type": "object"
          },
          "success": {
            "const": true
          }
        },
        "required": [
          "success",
          "footnote"
        ],
        "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>

<Accordion title="Raw success schema">
  ```json theme={null}
  {
    "additionalProperties": false,
    "properties": {
      "footnote": {
        "additionalProperties": false,
        "properties": {
          "entityType": {
            "const": "footnote"
          },
          "kind": {
            "const": "entity"
          },
          "noteId": {
            "type": "string"
          }
        },
        "required": [
          "kind",
          "entityType",
          "noteId"
        ],
        "type": "object"
      },
      "success": {
        "const": true
      }
    },
    "required": [
      "success",
      "footnote"
    ],
    "type": "object"
  }
  ```
</Accordion>

<Accordion title="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"
  }
  ```
</Accordion>