> ## 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.

# sections.setPageNumbering

> Set page numbering format/start and chapter numbering settings for a section.

## Summary

Set page numbering format/start and chapter numbering settings for a section.

* Operation ID: `sections.setPageNumbering`
* API member path: `editor.doc.sections.setPageNumbering(...)`
* 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 numbering settings already match.

## Input fields

### Variant 1 (target.kind="section")

| Field | Type | Required | Description |
| - | - | - | - |
| `start` | integer | yes | |
| `target` | SectionAddress | yes | SectionAddress |
| `target.kind` | `"section"` | yes | Constant: `"section"` |
| `target.sectionId` | string | yes | |

### Variant 2 (target.kind="section")

| Field | Type | Required | Description |
| - | - | - | - |
| `format` | enum | yes | `"decimal"`, `"lowerLetter"`, `"upperLetter"`, `"lowerRoman"`, `"upperRoman"`, `"numberInDash"` |
| `target` | SectionAddress | yes | SectionAddress |
| `target.kind` | `"section"` | yes | Constant: `"section"` |
| `target.sectionId` | string | yes | |

### Variant 3 (target.kind="section")

| Field | Type | Required | Description |
| - | - | - | - |
| `chapterStyle` | integer | yes | |
| `target` | SectionAddress | yes | SectionAddress |
| `target.kind` | `"section"` | yes | Constant: `"section"` |
| `target.sectionId` | string | yes | |

### Variant 4 (target.kind="section")

| Field | Type | Required | Description |
| - | - | - | - |
| `chapterSeparator` | enum | yes | `"hyphen"`, `"period"`, `"colon"`, `"emDash"`, `"enDash"` |
| `target` | SectionAddress | yes | SectionAddress |
| `target.kind` | `"section"` | yes | Constant: `"section"` |
| `target.sectionId` | string | yes | |

### Example request

```json theme={null}
{
  "start": 1,
  "target": {
    "kind": "section",
    "sectionId": "example"
  }
}
```

## Output fields

### Variant 1 (success=true)

| 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

```json theme={null}
{
  "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

> [accordion] Raw input schema
>
> ```json theme={null}
> {
>   "additionalProperties": false,
>   "anyOf": [
>     {
>       "required": [
>         "target",
>         "start"
>       ]
>     },
>     {
>       "required": [
>         "target",
>         "format"
>       ]
>     },
>     {
>       "required": [
>         "target",
>         "chapterStyle"
>       ]
>     },
>     {
>       "required": [
>         "target",
>         "chapterSeparator"
>       ]
>     }
>   ],
>   "properties": {
>     "chapterSeparator": {
>       "enum": [
>         "hyphen",
>         "period",
>         "colon",
>         "emDash",
>         "enDash"
>       ],
>       "type": "string"
>     },
>     "chapterStyle": {
>       "minimum": 1,
>       "type": "integer"
>     },
>     "format": {
>       "enum": [
>         "decimal",
>         "lowerLetter",
>         "upperLetter",
>         "lowerRoman",
>         "upperRoman",
>         "numberInDash"
>       ]
>     },
>     "start": {
>       "minimum": 1,
>       "type": "integer"
>     },
>     "target": {
>       "$ref": "#/$defs/SectionAddress"
>     }
>   },
>   "required": [
>     "target"
>   ],
>   "type": "object"
> }
> ```

> [accordion] Raw output schema
>
> ```json theme={null}
> {
>   "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"
>     }
>   ]
> }
> ```

> [accordion] Raw success schema
>
> ```json theme={null}
> {
>   "additionalProperties": false,
>   "properties": {
>     "section": {
>       "$ref": "#/$defs/SectionAddress"
>     },
>     "success": {
>       "const": true
>     }
>   },
>   "required": [
>     "success",
>     "section"
>   ],
>   "type": "object"
> }
> ```

> [accordion] Raw failure schema
>
> ```json theme={null}
> {
>   "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"
> }
> ```


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