Update Site Member Role (by email)

Update a site member's role, identifying them by email address. On a site with Site-specific access enabled, the member must already hold access to this site — grant it first with `POST`. On a site open to the whole workspace, this call sets a per-site role for the first time. Equivalent to [Update Site Member Role](/data/reference/enterprise/site-access/update-member-role), which identifies the member by ID instead. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning> Required scope | `site_access:write`

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

site_idstringRequiredformat: "objectid"
Unique identifier for a Site

Query parameters

emailstringRequired
Email address of the Site Member whose role to change

Request

This endpoint expects an object.
siteRoleenumRequired
The Site Role to assign
siteRoleIdstringOptionalformat: "objectid"

ID of the custom Site Role to assign. Required when siteRole is custom, and rejected with any other siteRole. Rejected if the id doesn’t name a custom Site Role belonging to this workspace.

Response

Request was successful
idstringformat: "objectid"
Unique identifier for the Member
rolesobject
Roles the Member holds
emailstringOptional
Email address of the Member
firstNamestringOptional
First name of the Member
lastNamestringOptional
Last name of the Member

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error