Document apiReferencePermission ranges

permissionRanges.updatePrincipal

Change which principal is allowed to edit a permission range. Updates the principal fields on the start marker.

mutates documentdry runidempotent
doc.permissionRanges.updatePrincipal(…)

Expected result

Returns a PermissionRangeMutationResult with the updated range info on success.

Inputs

idstringrequired
principalobjectrequired
Fields
kind"everyone" | "editor"required
idstring

Result

Output fields

No fields.

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
1 more codes
  • CAPABILITY_UNAVAILABLE

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas