Update A Workspace Member By Email
PATCH
/shares/workspace/members/by-email/{email}
const url = 'https://app.metakip.com/api/v1/shares/workspace/members/by-email/hello%40example.com';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"role":"viewer"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://app.metakip.com/api/v1/shares/workspace/members/by-email/hello%40example.com \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "role": "viewer" }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”email
required
string format: email
The recipient email address.
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
role
required
string
Responses
Section titled “Responses”Workspace role updated.
Media typeapplication/json
object
ok
required
boolean
message
required
string
Example
{ "ok": true}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" }}