bookmarks.rename

Summary

Rename an existing bookmark.

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

Expected result

Returns a BookmarkMutationResult indicating success with the updated bookmark address or a failure.

Input fields

Field	Type	Required	Description
`newName`	string	yes
`target`	object(kind=“entity”)	yes
`target.entityType`	`"bookmark"`	yes	Constant: `"bookmark"`
`target.kind`	`"entity"`	yes	Constant: `"entity"`
`target.name`	string	yes
`target.story`	StoryLocator	no	StoryLocator

Example request

{
  "newName": "example",
  "target": {
    "entityType": "bookmark",
    "kind": "entity",
    "name": "example",
    "story": {
      "kind": "story",
      "storyType": "body"
    }
  }
}

Output fields

Variant 1 (success=true)

Field	Type	Required	Description
`bookmark`	object(kind=“entity”)	yes
`bookmark.entityType`	`"bookmark"`	yes	Constant: `"bookmark"`
`bookmark.kind`	`"entity"`	yes	Constant: `"entity"`
`bookmark.name`	string	yes
`bookmark.story`	StoryLocator	no	StoryLocator
`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

{
  "bookmark": {
    "entityType": "bookmark",
    "kind": "entity",
    "name": "example",
    "story": {
      "kind": "story",
      "storyType": "body"
    }
  },
  "success": true
}

Pre-apply throws

TARGET_NOT_FOUND
INVALID_TARGET
INVALID_INPUT
CAPABILITY_UNAVAILABLE

Non-applied failure codes

None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "newName": {
      "type": "string"
    },
    "target": {
      "additionalProperties": false,
      "properties": {
        "entityType": {
          "const": "bookmark"
        },
        "kind": {
          "const": "entity"
        },
        "name": {
          "type": "string"
        },
        "story": {
          "$ref": "#/$defs/StoryLocator"
        }
      },
      "required": [
        "kind",
        "entityType",
        "name"
      ],
      "type": "object"
    }
  },
  "required": [
    "target",
    "newName"
  ],
  "type": "object"
}

Raw output schema

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "bookmark": {
          "additionalProperties": false,
          "properties": {
            "entityType": {
              "const": "bookmark"
            },
            "kind": {
              "const": "entity"
            },
            "name": {
              "type": "string"
            },
            "story": {
              "$ref": "#/$defs/StoryLocator"
            }
          },
          "required": [
            "kind",
            "entityType",
            "name"
          ],
          "type": "object"
        },
        "success": {
          "const": true
        }
      },
      "required": [
        "success",
        "bookmark"
      ],
      "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"
    }
  ]
}

Raw success schema

{
  "additionalProperties": false,
  "properties": {
    "bookmark": {
      "additionalProperties": false,
      "properties": {
        "entityType": {
          "const": "bookmark"
        },
        "kind": {
          "const": "entity"
        },
        "name": {
          "type": "string"
        },
        "story": {
          "$ref": "#/$defs/StoryLocator"
        }
      },
      "required": [
        "kind",
        "entityType",
        "name"
      ],
      "type": "object"
    },
    "success": {
      "const": true
    }
  },
  "required": [
    "success",
    "bookmark"
  ],
  "type": "object"
}

Raw failure schema

{
  "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"
}

Getting Started

Editor

Document Engine

AI

Solutions

Resources

Summary

Expected result

Input fields

Example request

Output fields

Variant 1 (success=true)

Variant 2 (success=false)

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas

​Summary

​Expected result

​Input fields

​Example request

​Output fields

​Variant 1 (success=true)

​Variant 2 (success=false)

​Example response

​Pre-apply throws

​Non-applied failure codes

​Raw schemas

Summary

Expected result

Input fields

Example request

Output fields

Variant 1 (success=true)

Variant 2 (success=false)

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas