Skip to content
Metakip Docs

Update Public Access

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

Makes a page or folder private, publicly viewable, or publicly editable. Public access can expose content to anyone with its URL.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “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 Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
permission
required
string
Allowed values: private view edit

Responses

Section titled “Responses”

200

Section titled “200”

Updated public access.

Media typeapplication/json
object
permission
required
string
Allowed values: private view edit
url
required
string format: uri
message
required
string
Example
{
  "permission": "private"
}

403

Section titled “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
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}