Invite workspace member

curl --request POST \
  --url https://app.base44.com/api/workspace/invitations/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "dana@acme.com",
  "approve_external_recipient": false,
  "role": "editor",
  "group_id": "68b4e1d2c9a7f3001e2d4b61"
}
'

import requests

url = "https://app.base44.com/api/workspace/invitations/invite"

payload = {
    "email": "dana@acme.com",
    "approve_external_recipient": False,
    "role": "editor",
    "group_id": "68b4e1d2c9a7f3001e2d4b61"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'dana@acme.com',
    approve_external_recipient: false,
    role: 'editor',
    group_id: '68b4e1d2c9a7f3001e2d4b61'
  })
};

fetch('https://app.base44.com/api/workspace/invitations/invite', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.base44.com/api/workspace/invitations/invite",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'dana@acme.com',
    'approve_external_recipient' => false,
    'role' => 'editor',
    'group_id' => '68b4e1d2c9a7f3001e2d4b61'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.base44.com/api/workspace/invitations/invite"

	payload := strings.NewReader("{\n  \"email\": \"dana@acme.com\",\n  \"approve_external_recipient\": false,\n  \"role\": \"editor\",\n  \"group_id\": \"68b4e1d2c9a7f3001e2d4b61\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.base44.com/api/workspace/invitations/invite")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"dana@acme.com\",\n  \"approve_external_recipient\": false,\n  \"role\": \"editor\",\n  \"group_id\": \"68b4e1d2c9a7f3001e2d4b61\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.base44.com/api/workspace/invitations/invite")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"dana@acme.com\",\n  \"approve_external_recipient\": false,\n  \"role\": \"editor\",\n  \"group_id\": \"68b4e1d2c9a7f3001e2d4b61\"\n}"

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Invitations

Invite workspace member

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

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.

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.

POST

api

workspace

invitations

invite

Invite workspace member

curl --request POST \
  --url https://app.base44.com/api/workspace/invitations/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "dana@acme.com",
  "approve_external_recipient": false,
  "role": "editor",
  "group_id": "68b4e1d2c9a7f3001e2d4b61"
}
'

import requests

url = "https://app.base44.com/api/workspace/invitations/invite"

payload = {
    "email": "dana@acme.com",
    "approve_external_recipient": False,
    "role": "editor",
    "group_id": "68b4e1d2c9a7f3001e2d4b61"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'dana@acme.com',
    approve_external_recipient: false,
    role: 'editor',
    group_id: '68b4e1d2c9a7f3001e2d4b61'
  })
};

fetch('https://app.base44.com/api/workspace/invitations/invite', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.base44.com/api/workspace/invitations/invite",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'dana@acme.com',
    'approve_external_recipient' => false,
    'role' => 'editor',
    'group_id' => '68b4e1d2c9a7f3001e2d4b61'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.base44.com/api/workspace/invitations/invite"

	payload := strings.NewReader("{\n  \"email\": \"dana@acme.com\",\n  \"approve_external_recipient\": false,\n  \"role\": \"editor\",\n  \"group_id\": \"68b4e1d2c9a7f3001e2d4b61\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.base44.com/api/workspace/invitations/invite")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"dana@acme.com\",\n  \"approve_external_recipient\": false,\n  \"role\": \"editor\",\n  \"group_id\": \"68b4e1d2c9a7f3001e2d4b61\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.base44.com/api/workspace/invitations/invite")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"dana@acme.com\",\n  \"approve_external_recipient\": false,\n  \"role\": \"editor\",\n  \"group_id\": \"68b4e1d2c9a7f3001e2d4b61\"\n}"

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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.

Query Parameters

workspaceId

string

required

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

Minimum string length: 1

Body

application/json

An invitation to join a workspace.

string

required

Email of the person to invite.

Required string length: 5 - 254

Example:

"dana@acme.com"

approve_external_recipient

boolean

default:false

Explicit school owner/admin approval for this recipient outside verified FERPA school domains.

role

enum<string>

default:viewer

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

Available options:

admin,

editor,

viewer

Example:

"editor"

group_id

string | null

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:

"68b4e1d2c9a7f3001e2d4b61"

Response

The invitation was saved. The body is null.

Base44 APIs

Apps API (Beta)

Workspace API (Beta)

Superagents API (Beta)

Monitoring API

Audit Logs API

Invite workspace member

Authorizations

Query Parameters

Body

Response