Sign in

Invite workspace member

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Invites someone to a workspace by email. The invitee gets an email with a link to join, and a notification in Base44 if they already have an account. The link works for 60 days.

role is the role they get when they accept. Set group_id to add them to a custom group when they accept.

You can't invite an existing member, or someone whose invitation is still pending. Send a pending invitation again with Resend workspace invitation. Inviting someone whose invitation expired sends a new one.

A 200 means the invitation was saved. It doesn't confirm the email was sent: if sending fails, the invitation still stands and you can send it again with Resend workspace invitation. The response body is null.

Inviting is limited to 6 requests per minute, shared by Invite workspace member, Invite workspace members in bulk, Resend workspace invitation, and Resend workspace invitations in bulk. A signed-in session has its own limit, and every personal access token for the workspace shares one. Some workspaces have a different limit.

<Note>Call this as an owner or admin of the workspace, with a personal access token for that workspace sent as a Bearer token, or from a signed-in session. A read-only token is refused, and workspace API keys aren't accepted.</Note>

post/api/workspace/invitations/invite

Query parameters

workspaceIdstring required

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

Request body

emailstring required

Email of the person to invite.

role'admin' | 'editor' | 'viewer'

Role the invitee gets when they accept. Defaults to viewer. admin needs the Business plan or higher.

group_idstring nullable

ID of a custom group to add the invitee to when they accept. Get it from List workspace groups. Needs a plan that includes groups.

Example request

{
  "email": "dana@acme.com",
  "role": "editor",
  "group_id": "68b4e1d2c9a7f3001e2d4b61"
}

Response

The invitation was saved. The body is null.

{"stackTrail":"paths:/api/workspace/invitations/invite:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 1 of the 39 revisions of this API.1