Skip to main content
POST
Invite app users

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id
string
required

ID of the app to invite the users to.

Body

application/json
user_emails
string[]
required

Email addresses to invite, up to 50 per call.

Maximum array length: 50
Example:
approve_external_recipients
boolean
default:false

Set to true to approve the recipients in this request who are outside verified school domains. Requires active owner or admin membership in the app's FERPA workspace.

Example:

false

role
string | null
default:user

Role the invited people get in the app, such as user or admin. It isn't checked against the roles the app defines.

Example:

"user"

collaborator_role
enum<string>

Set to editor to also let them edit the app in Base44.

Available options:
editor
Example:

"editor"

add_as_guest
boolean
default:false

With collaborator_role set to editor, adds anyone outside the app's workspace to it as a guest instead of failing their invitation.

Example:

false

Response

The outcome of each invitation.

The outcome of each invitation, in the order you sent them.

results
InviteUserResult · object[]
required

One entry per address you sent.

Example: