Skip to content
Metakip Docs

Update A Direct Share By Email

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

Finds and updates a direct share under the entity access lock. Only the owner can change Admin access.

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.

email
required
string format: email

The recipient email address.

Request Bodyrequired

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

Responses

Section titled “Responses”

200

Section titled “200”

Share permission updated.

Media typeapplication/json
object
ok
required
boolean
message
required
string
Example
{
  "ok": true
}

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