Skip to main content

Invite or update member request

Who to invite or update and with which access.

emailstringrequired

Matched case-insensitively against existing members.

licensestringrequired

Possible values: [editor, viewer]

org_rolestringrequired

Possible values: [admin, member, viewer]

project_idsstring[]

Restricted workspaces (projects) to give them access to. Defaults to none.

send_invite_emailboolean

Send the invitation email to a newly invited member.

Default value: true
external_userboolean

Invite them with a password login even when the organization uses single sign-on.

Default value: false
Invite or update member request
{
  "email": "string",
  "license": "editor",
  "org_role": "admin",
  "project_ids": [
    "string"
  ],
  "send_invite_email": true,
  "external_user": false
}