Invite someone to a team
curl --request POST \
--url https://api.liara.ir/v2/teams/{teamID}/invitations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "teammate@example.com",
"roleID": "000000000000000000000020"
}
'import requests
url = "https://api.liara.ir/v2/teams/{teamID}/invitations"
payload = {
"email": "teammate@example.com",
"roleID": "000000000000000000000020"
}
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: 'teammate@example.com', roleID: '000000000000000000000020'})
};
fetch('https://api.liara.ir/v2/teams/{teamID}/invitations', 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.liara.ir/v2/teams/{teamID}/invitations",
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' => 'teammate@example.com',
'roleID' => '000000000000000000000020'
]),
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.liara.ir/v2/teams/{teamID}/invitations"
payload := strings.NewReader("{\n \"email\": \"teammate@example.com\",\n \"roleID\": \"000000000000000000000020\"\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.liara.ir/v2/teams/{teamID}/invitations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"teammate@example.com\",\n \"roleID\": \"000000000000000000000020\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.liara.ir/v2/teams/{teamID}/invitations")
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\": \"teammate@example.com\",\n \"roleID\": \"000000000000000000000020\"\n}"
response = http.request(request)
puts response.read_body{
"link": "https://console.liara.ir/invite/join?token=<invitation-token>"
}Invitations
Invite someone to a team
Emails an invitation to join the team with the given role, and returns the invitation link. The link is valid for 3 days and only works for the account with the invited email address. Needs the team.operate or team.manage permission.
While an invitation for an email address is pending, you can’t send another one to the same address; delete the pending one first.
POST
/
v2
/
teams
/
{teamID}
/
invitations
Invite someone to a team
curl --request POST \
--url https://api.liara.ir/v2/teams/{teamID}/invitations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "teammate@example.com",
"roleID": "000000000000000000000020"
}
'import requests
url = "https://api.liara.ir/v2/teams/{teamID}/invitations"
payload = {
"email": "teammate@example.com",
"roleID": "000000000000000000000020"
}
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: 'teammate@example.com', roleID: '000000000000000000000020'})
};
fetch('https://api.liara.ir/v2/teams/{teamID}/invitations', 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.liara.ir/v2/teams/{teamID}/invitations",
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' => 'teammate@example.com',
'roleID' => '000000000000000000000020'
]),
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.liara.ir/v2/teams/{teamID}/invitations"
payload := strings.NewReader("{\n \"email\": \"teammate@example.com\",\n \"roleID\": \"000000000000000000000020\"\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.liara.ir/v2/teams/{teamID}/invitations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"teammate@example.com\",\n \"roleID\": \"000000000000000000000020\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.liara.ir/v2/teams/{teamID}/invitations")
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\": \"teammate@example.com\",\n \"roleID\": \"000000000000000000000020\"\n}"
response = http.request(request)
puts response.read_body{
"link": "https://console.liara.ir/invite/join?token=<invitation-token>"
}Authorizations
Send your API token as Authorization: Bearer <api-token>.
Path Parameters
The team's ID. 24-character hexadecimal ID.
Pattern:
^[0-9a-fA-F]{24}$Body
application/json
Response
The invitation was sent.
Link the invited person opens to accept.
⌘I
