Invite Member
curl --request POST \
--url https://api.example.com/api/auth/organizations/invite \
--header 'Content-Type: application/json' \
--header 'X-Organization-Id: <x-organization-id>' \
--data '
{
"email": "<string>",
"role": "<string>"
}
'import requests
url = "https://api.example.com/api/auth/organizations/invite"
payload = {
"email": "<string>",
"role": "<string>"
}
headers = {
"X-Organization-Id": "<x-organization-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Organization-Id': '<x-organization-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: '<string>', role: '<string>'})
};
fetch('https://api.example.com/api/auth/organizations/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.example.com/api/auth/organizations/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' => '<string>',
'role' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Organization-Id: <x-organization-id>"
],
]);
$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.example.com/api/auth/organizations/invite"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Organization-Id", "<x-organization-id>")
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.example.com/api/auth/organizations/invite")
.header("X-Organization-Id", "<x-organization-id>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/auth/organizations/invite")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"invite_id": "inv_xyz789",
"invite_link": "https://app.getbutter.ai/signup?invite=inv_xyz789&email=newuser@example.com",
"message": "Invitation sent to newuser@example.com"
}
Organizations
Invite Member
POST
/
api
/
auth
/
organizations
/
invite
Invite Member
curl --request POST \
--url https://api.example.com/api/auth/organizations/invite \
--header 'Content-Type: application/json' \
--header 'X-Organization-Id: <x-organization-id>' \
--data '
{
"email": "<string>",
"role": "<string>"
}
'import requests
url = "https://api.example.com/api/auth/organizations/invite"
payload = {
"email": "<string>",
"role": "<string>"
}
headers = {
"X-Organization-Id": "<x-organization-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Organization-Id': '<x-organization-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: '<string>', role: '<string>'})
};
fetch('https://api.example.com/api/auth/organizations/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.example.com/api/auth/organizations/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' => '<string>',
'role' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Organization-Id: <x-organization-id>"
],
]);
$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.example.com/api/auth/organizations/invite"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Organization-Id", "<x-organization-id>")
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.example.com/api/auth/organizations/invite")
.header("X-Organization-Id", "<x-organization-id>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/auth/organizations/invite")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"invite_id": "inv_xyz789",
"invite_link": "https://app.getbutter.ai/signup?invite=inv_xyz789&email=newuser@example.com",
"message": "Invitation sent to newuser@example.com"
}
Invite a new user to join your organization via email.
Request
string
required
The unique identifier of the organization.
string
required
The email address of the user to invite.
string
required
The role to assign to the invited user. Must be one of
admin, agent_manager, or user.Response
boolean
Indicates whether the invitation was successfully created.
string
The unique identifier for the created invitation.
string
The signup link that can be shared with the invited user.
string
A descriptive message about the operation result.
{
"success": true,
"invite_id": "inv_xyz789",
"invite_link": "https://app.getbutter.ai/signup?invite=inv_xyz789&email=newuser@example.com",
"message": "Invitation sent to newuser@example.com"
}
⌘I