Invites a member to be part of the team. The member will need to create their account if they don't exist.
curl --request POST \
--url https://api.sandbox.goteal.co/members \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"email": "john.smith@goteal.co",
"role": "FullMember"
}
'import requests
url = "https://api.sandbox.goteal.co/members"
payload = {
"email": "john.smith@goteal.co",
"role": "FullMember"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: 'john.smith@goteal.co', role: 'FullMember'})
};
fetch('https://api.sandbox.goteal.co/members', 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.sandbox.goteal.co/members",
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' => 'john.smith@goteal.co',
'role' => 'FullMember'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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.sandbox.goteal.co/members"
payload := strings.NewReader("{\n \"email\": \"john.smith@goteal.co\",\n \"role\": \"FullMember\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.sandbox.goteal.co/members")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"john.smith@goteal.co\",\n \"role\": \"FullMember\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.goteal.co/members")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"john.smith@goteal.co\",\n \"role\": \"FullMember\"\n}"
response = http.request(request)
puts response.read_body{
"email": "john.smith@goteal.co",
"role": "Owner",
"status": "unconfirmed",
"mfa_status": "sms",
"name": "John Smith"
}{
"errors": [
"The request is missing the required field `name`"
]
}{
"errors": [
"No X-API-KEY header provided or wrong value"
]
}Invite a Member
POST
/
members
Invites a member to be part of the team. The member will need to create their account if they don't exist.
curl --request POST \
--url https://api.sandbox.goteal.co/members \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"email": "john.smith@goteal.co",
"role": "FullMember"
}
'import requests
url = "https://api.sandbox.goteal.co/members"
payload = {
"email": "john.smith@goteal.co",
"role": "FullMember"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: 'john.smith@goteal.co', role: 'FullMember'})
};
fetch('https://api.sandbox.goteal.co/members', 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.sandbox.goteal.co/members",
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' => 'john.smith@goteal.co',
'role' => 'FullMember'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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.sandbox.goteal.co/members"
payload := strings.NewReader("{\n \"email\": \"john.smith@goteal.co\",\n \"role\": \"FullMember\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.sandbox.goteal.co/members")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"john.smith@goteal.co\",\n \"role\": \"FullMember\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.goteal.co/members")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"john.smith@goteal.co\",\n \"role\": \"FullMember\"\n}"
response = http.request(request)
puts response.read_body{
"email": "john.smith@goteal.co",
"role": "Owner",
"status": "unconfirmed",
"mfa_status": "sms",
"name": "John Smith"
}{
"errors": [
"The request is missing the required field `name`"
]
}{
"errors": [
"No X-API-KEY header provided or wrong value"
]
}Authorizations
ApiKeyAuthMemberBearerAuth
Body
application/json
Response
Created
Example:
"john.smith@goteal.co"
The Role of the Member
Example:
"Owner"
the status of the Member
Available options:
unconfirmed, confirmed, archived, compromised, unknown, reset_required, force_change_password, external_provider Example:
"unconfirmed"
the status of the Member
Available options:
sms, email, disabled Example:
"sms"
Names of the Member
Example:
"John Smith"
⌘I