Update Inherited Access

PATCH

/shares/entity/{entityType}/{entityId}/inheritance

curl --request PATCH \
  --url https://app.metakip.com/api/v1/shares/entity/page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/inheritance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "policy": "inherit" }'

• Hosted Metakip API
• Relative to the current Metakip server.

Controls whether a page or folder inherits access from its parent folders and workspace.

Authorizations

• bearerToken
• browserSession

Parameters

Path Parameters

entityType

required

string

Allowed values: page folder

The kind of Metakip entity to share.

entityId

required

string format: uuid

The UUID of the entity.

Request Body^required

Media typeapplication/json

object

policy

required

string

Allowed values: inherit restricted

Responses

200

Updated inheritance policy.

Media typeapplication/json

object

policy

required

string

Allowed values: inherit restricted

message

required

string

Example

{
  "policy": "inherit"
}

403

The API token is missing a required scope: pages:write.

Media typeapplication/json

Structured error returned when the request cannot be completed.

object

error

required

Error details for programmatic handling.

object

code

required

Stable error code.

string

message

required

Human-readable explanation.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}