Invite or update an organization member
POST/members
Invites a person by email, or updates the license and org role of an existing member with that email, like the Invite members dialog of the Members page.
A new member gets the invitation email unless send_invite_email is false, also when the
organization uses single sign-on. Workspaces listed in project_ids give them Workspace Member
access (Workspace Viewer for an Org Viewer) in restricted workspaces where they have no access
yet. Org Admins already have Workspace Admin access to every workspace, so project_ids
changes nothing for them; give an Org Admin a lower role in a workspace with
PATCH /projects/{project_id}/members/{membership_id}.
license and org_role are both optional. For an existing member a missing org role follows the
license, as in PATCH /members/{membership_id}, a missing license stays as it is, and sending
neither leaves their access as it is. Someone new gets an Editor license and Org Member role when neither is sent,
a Viewer license with org_role: viewer, an Editor license with any other org role, and the
org role that fits the license when only license is sent.
The license and org role have to match: a Viewer license is always an Org Viewer, and an Editor
license is an Org Admin or an Org Member. Making someone on a Viewer license an Org Admin or Org
Member needs license: editor in the same request, and making someone on an Editor license an
Org Viewer needs license: viewer, otherwise it answers with 400. The Org
Owner's license and org role can't be changed.
Invitations count towards the same invite rate limits as the Members page and answer with 429
when one is reached.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 405
- 429
OK
The request is invalid.
The API key header is missing, or the API key is invalid, disabled or expired.
The API key is not allowed to do this, for example a key that isn't allowed to manage members.
The project or resource was not found.
The requested HTTP method is not allowed.
Too many requests sent with the same API key. Up to 10 requests can be sent within 1 second.