Invite a user
Tool: oppex.admin.inviteUser
Emails an invitation to someone who does not have an Oppex account yet, to join your connection's workspace with the role you choose. It works the same as + Invite User in Oppex, and the invitation is recorded as sent by you. To give an existing Oppex user access to another workspace, use Add a user to a workspace instead.
What you provide
| Input | Required | Description |
|---|---|---|
| Yes | The person's email address. It must be in your organization's approved email domain. | |
| Role | Yes | Responder, Service Admin, Workspace Admin, Account Admin or Account Owner. You can only choose a role up to your own. |
Example prompts
- "Invite leia.organa@rebellion.example.com as a Responder."
- "Send Workspace Admin invites to han.solo@rebellion.example.com and chewie@rebellion.example.com."
- "Invite our new SRE, priya.nair@example.com, with the same role as me."
When you invite several people in one prompt, the assistant sends one invitation per person.
Who can use it
| Your role | You can invite up to |
|---|---|
| Responder | You cannot invite anyone. |
| Service Admin | Service Admin |
| Workspace Admin | Workspace Admin, in a workspace you belong to |
| Account Admin | Account Admin |
| Account Owner | Any role |
Limits and errors
| Message | Meaning |
|---|---|
| "Email domain not whitelisted for this client" | The address is outside your organization's approved email domain. Subdomains do not count as a match. |
| "User <email> already Signed Up" | The person already has an active account. Use Add a user to a workspace. |
| "Cannot invite roleCode <n> (<role>): exceeds your own role <your role>. …" | You asked for a role above your own. |
| "Workspace admin can only invite users to their own workspace" | You are a Workspace Admin who is not a member of the connection's workspace. |
| "Invalid email address" | The address is not a valid email. |
What happens next
Oppex emails the invitation from no-reply@mailer.oppex.ai, with the subject "<your name> has invited you to join Oppex." The person has 7 days to sign up. Inviting the same address again cancels the earlier invitation and sends a new one.