Skip to main content

Summary

Remove a permission range by ID. Removes whichever markers exist for the given ID (start, end, or both).
  • Operation ID: permissionRanges.remove
  • API member path: editor.doc.permissionRanges.remove(...)
  • Mutates document: yes
  • Idempotency: idempotent
  • Supports tracked mode: no
  • Supports dry run: yes
  • Deterministic target resolution: yes

Expected result

Returns a PermissionRangeRemoveResult indicating success or a failure.

Input fields

FieldTypeRequiredDescription
idstringyes

Example request

{
  "id": "id-001"
}

Output fields

No fields.

Example response

{}

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE

Non-applied failure codes

  • None

Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}
{
  "type": "object"
}
{
  "type": "object"
}
{
  "type": "object"
}