curl --request POST \
--url 'https://api.flashcat.cloud/member/invite?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"members": [
{
"member_name": "Charlie",
"email": "charlie@example.com",
"locale": "en-US",
"time_zone": "Asia/Shanghai",
"role_ids": [
6
]
},
{
"member_name": "Dave",
"phone": "13800138000",
"country_code": "CN",
"locale": "zh-CN",
"time_zone": "Asia/Shanghai"
}
]
}
'import requests
url = "https://api.flashcat.cloud/member/invite?app_key="
payload = { "members": [
{
"member_name": "Charlie",
"email": "charlie@example.com",
"locale": "en-US",
"time_zone": "Asia/Shanghai",
"role_ids": [6]
},
{
"member_name": "Dave",
"phone": "13800138000",
"country_code": "CN",
"locale": "zh-CN",
"time_zone": "Asia/Shanghai"
}
] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
members: [
{
member_name: 'Charlie',
email: 'charlie@example.com',
locale: 'en-US',
time_zone: 'Asia/Shanghai',
role_ids: [6]
},
{
member_name: 'Dave',
phone: '13800138000',
country_code: 'CN',
locale: 'zh-CN',
time_zone: 'Asia/Shanghai'
}
]
})
};
fetch('https://api.flashcat.cloud/member/invite?app_key=', 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.flashcat.cloud/member/invite?app_key=",
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([
'members' => [
[
'member_name' => 'Charlie',
'email' => 'charlie@example.com',
'locale' => 'en-US',
'time_zone' => 'Asia/Shanghai',
'role_ids' => [
6
]
],
[
'member_name' => 'Dave',
'phone' => '13800138000',
'country_code' => 'CN',
'locale' => 'zh-CN',
'time_zone' => 'Asia/Shanghai'
]
]
]),
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.flashcat.cloud/member/invite?app_key="
payload := strings.NewReader("{\n \"members\": [\n {\n \"member_name\": \"Charlie\",\n \"email\": \"charlie@example.com\",\n \"locale\": \"en-US\",\n \"time_zone\": \"Asia/Shanghai\",\n \"role_ids\": [\n 6\n ]\n },\n {\n \"member_name\": \"Dave\",\n \"phone\": \"13800138000\",\n \"country_code\": \"CN\",\n \"locale\": \"zh-CN\",\n \"time_zone\": \"Asia/Shanghai\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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.flashcat.cloud/member/invite?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"members\": [\n {\n \"member_name\": \"Charlie\",\n \"email\": \"charlie@example.com\",\n \"locale\": \"en-US\",\n \"time_zone\": \"Asia/Shanghai\",\n \"role_ids\": [\n 6\n ]\n },\n {\n \"member_name\": \"Dave\",\n \"phone\": \"13800138000\",\n \"country_code\": \"CN\",\n \"locale\": \"zh-CN\",\n \"time_zone\": \"Asia/Shanghai\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/member/invite?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"members\": [\n {\n \"member_name\": \"Charlie\",\n \"email\": \"charlie@example.com\",\n \"locale\": \"en-US\",\n \"time_zone\": \"Asia/Shanghai\",\n \"role_ids\": [\n 6\n ]\n },\n {\n \"member_name\": \"Dave\",\n \"phone\": \"13800138000\",\n \"country_code\": \"CN\",\n \"locale\": \"zh-CN\",\n \"time_zone\": \"Asia/Shanghai\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"items": [
{
"member_id": 5068740052131,
"member_name": "Charlie"
}
]
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}Invite members
Batch invite new members to the organization by email or phone.
curl --request POST \
--url 'https://api.flashcat.cloud/member/invite?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"members": [
{
"member_name": "Charlie",
"email": "charlie@example.com",
"locale": "en-US",
"time_zone": "Asia/Shanghai",
"role_ids": [
6
]
},
{
"member_name": "Dave",
"phone": "13800138000",
"country_code": "CN",
"locale": "zh-CN",
"time_zone": "Asia/Shanghai"
}
]
}
'import requests
url = "https://api.flashcat.cloud/member/invite?app_key="
payload = { "members": [
{
"member_name": "Charlie",
"email": "charlie@example.com",
"locale": "en-US",
"time_zone": "Asia/Shanghai",
"role_ids": [6]
},
{
"member_name": "Dave",
"phone": "13800138000",
"country_code": "CN",
"locale": "zh-CN",
"time_zone": "Asia/Shanghai"
}
] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
members: [
{
member_name: 'Charlie',
email: 'charlie@example.com',
locale: 'en-US',
time_zone: 'Asia/Shanghai',
role_ids: [6]
},
{
member_name: 'Dave',
phone: '13800138000',
country_code: 'CN',
locale: 'zh-CN',
time_zone: 'Asia/Shanghai'
}
]
})
};
fetch('https://api.flashcat.cloud/member/invite?app_key=', 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.flashcat.cloud/member/invite?app_key=",
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([
'members' => [
[
'member_name' => 'Charlie',
'email' => 'charlie@example.com',
'locale' => 'en-US',
'time_zone' => 'Asia/Shanghai',
'role_ids' => [
6
]
],
[
'member_name' => 'Dave',
'phone' => '13800138000',
'country_code' => 'CN',
'locale' => 'zh-CN',
'time_zone' => 'Asia/Shanghai'
]
]
]),
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.flashcat.cloud/member/invite?app_key="
payload := strings.NewReader("{\n \"members\": [\n {\n \"member_name\": \"Charlie\",\n \"email\": \"charlie@example.com\",\n \"locale\": \"en-US\",\n \"time_zone\": \"Asia/Shanghai\",\n \"role_ids\": [\n 6\n ]\n },\n {\n \"member_name\": \"Dave\",\n \"phone\": \"13800138000\",\n \"country_code\": \"CN\",\n \"locale\": \"zh-CN\",\n \"time_zone\": \"Asia/Shanghai\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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.flashcat.cloud/member/invite?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"members\": [\n {\n \"member_name\": \"Charlie\",\n \"email\": \"charlie@example.com\",\n \"locale\": \"en-US\",\n \"time_zone\": \"Asia/Shanghai\",\n \"role_ids\": [\n 6\n ]\n },\n {\n \"member_name\": \"Dave\",\n \"phone\": \"13800138000\",\n \"country_code\": \"CN\",\n \"locale\": \"zh-CN\",\n \"time_zone\": \"Asia/Shanghai\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/member/invite?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"members\": [\n {\n \"member_name\": \"Charlie\",\n \"email\": \"charlie@example.com\",\n \"locale\": \"en-US\",\n \"time_zone\": \"Asia/Shanghai\",\n \"role_ids\": [\n 6\n ]\n },\n {\n \"member_name\": \"Dave\",\n \"phone\": \"13800138000\",\n \"country_code\": \"CN\",\n \"locale\": \"zh-CN\",\n \"time_zone\": \"Asia/Shanghai\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"items": [
{
"member_id": 5068740052131,
"member_name": "Charlie"
}
]
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}Restrictions
| Aspect | Value |
|---|---|
| Rate limits | 1,000 requests/minute; 50 requests/second per account |
| Permissions | Members Manage (organization) |
Usage
country_codemust be an ISO 3166-1 alpha-2 region code (e.g. “CN”). It is validated and normalized to upper case before storage; invalid values are rejected with a 400.- When a member’s
phonehas no ”+” prefix, it is parsed with that member’scountry_codeas the region hint (defaults to “CN” when omitted).
Authorizations
App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.
Body
Invite members request
Members to invite (max 20)
Show child attributes
Show child attributes
Invite source. Only takes effect when the account has member invites disabled and the value is api: members are created directly in the enabled state with email/phone marked verified and no invitation sent. Any other value follows the normal invite flow
Response
Success
Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.
Was this page helpful?