Skip to main content
POST
/
api
/
users
/
invite
Invite user to workspace
curl --request POST \
  --url https://api.staging.whilst.app/api/users/invite \
  --header 'Content-Type: application/json' \
  --cookie whilst_session= \
  --data '
{
  "email": "colleague@acme.com",
  "role": "member"
}
'
import requests

url = "https://api.staging.whilst.app/api/users/invite"

payload = {
"email": "colleague@acme.com",
"role": "member"
}
headers = {
"cookie": "whilst_session=",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {cookie: 'whilst_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({email: 'colleague@acme.com', role: 'member'})
};

fetch('https://api.staging.whilst.app/api/users/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://api.staging.whilst.app/api/users/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' => 'colleague@acme.com',
'role' => 'member'
]),
CURLOPT_COOKIE => "whilst_session=",
CURLOPT_HTTPHEADER => [
"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://api.staging.whilst.app/api/users/invite"

payload := strings.NewReader("{\n \"email\": \"colleague@acme.com\",\n \"role\": \"member\"\n}")

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

req.Header.Add("cookie", "whilst_session=")
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://api.staging.whilst.app/api/users/invite")
.header("cookie", "whilst_session=")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"colleague@acme.com\",\n \"role\": \"member\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.staging.whilst.app/api/users/invite")

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

request = Net::HTTP::Post.new(url)
request["cookie"] = 'whilst_session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"colleague@acme.com\",\n \"role\": \"member\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "<string>",
  "invitationId": "<string>",
  "invitationUrl": "<string>"
}
{
"message": "<string>",
"code": "<string>",
"details": {}
}
{
"message": "<string>",
"code": "<string>",
"details": {}
}
{
"message": "<string>",
"code": "<string>",
"details": {}
}
{
"message": "<string>",
"code": "<string>",
"details": {}
}
{
"message": "<string>",
"code": "<string>",
"details": {}
}

Authorizations

whilst_session
string
cookie
required

JWT session token for authenticated users

Body

application/json
email
string<email>
required

Email address of the user to invite

Example:

"colleague@acme.com"

role
enum<string>
default:member
required

Role to assign to the invited user

Available options:
admin,
member

Response

Invitation sent successfully

success
boolean
required
message
string
required
invitationId
string

WorkOS invitation ID (if available)

invitationUrl
string<uri>

Direct signup URL (fallback method)