Invite or update a user

Sends an invitation to a user to join the organization. If the user is already a member, updates their role to the specified value. If the user has a pending invite, returns the current status without changes. If the organization has reached its seat limit, returns status “error” with a descriptive error message.

POST /api/v0/organization/users/invite

Invite or update a user

cURL

curl --request POST \
  --url https://api.factory.ai/api/v0/organization/users/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[e-mail]",
  "role": "user"
}
'

import requests

url = "https://api.factory.ai/api/v0/organization/users/invite"

payload = {
    "email": "[e-mail]",
    "role": "user"
}
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: '[e-mail]', role: 'user'})
};

fetch('https://api.factory.ai/api/v0/organization/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.factory.ai/api/v0/organization/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' => '[e-mail]',
    'role' => 'user'
  ]),
  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://api.factory.ai/api/v0/organization/users/invite"

	payload := strings.NewReader("{\n  \"email\": \"[e-mail]\",\n  \"role\": \"user\"\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://api.factory.ai/api/v0/organization/users/invite")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"[e-mail]\",\n  \"role\": \"user\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.factory.ai/api/v0/organization/users/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\": \"[e-mail]\",\n  \"role\": \"user\"\n}"

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

200

{
  "email": "[e-mail]",
  "error": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

Authorizations

Authorization · string · header · required

Factory API key or JWT token for authentication

Body

application/json

email · string<email> · required

Email address to invite

role · enum<string> · default: user

Role to assign (defaults to user)

Available options: user, manager, owner

Response

200

application/json

Response for status 200

email · string<email> · required

Invited email address

role · enum<string> · required

Assigned role

Available options: user, manager, owner

status · enum<string> · required

Result of the invite operation

Available options: invited, already_member, role_updated, already_invited, error

error · string

Error message if status is error