Create invitation
Creates an invitation. The key owner must be an organization admin; the inviter is recorded as the key owner. The invitee is masked in the response, same as the list endpoint.
POST
/
v1
/
admin
/
organizations
/
invites
Create organization invitation
curl --request POST \
--url https://api.moonshot.ai/v1/admin/organizations/invites \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"invitee": "[email protected]",
"invitee_type": "email",
"role": "member"
}
'import requests
url = "https://api.moonshot.ai/v1/admin/organizations/invites"
payload = {
"invitee": "[email protected]",
"invitee_type": "email",
"role": "member"
}
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({invitee: '[email protected]', invitee_type: 'email', role: 'member'})
};
fetch('https://api.moonshot.ai/v1/admin/organizations/invites', 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.moonshot.ai/v1/admin/organizations/invites",
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([
'invitee' => '[email protected]',
'invitee_type' => 'email',
'role' => 'member'
]),
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.moonshot.ai/v1/admin/organizations/invites"
payload := strings.NewReader("{\n \"invitee\": \"[email protected]\",\n \"invitee_type\": \"email\",\n \"role\": \"member\"\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.moonshot.ai/v1/admin/organizations/invites")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"invitee\": \"[email protected]\",\n \"invitee_type\": \"email\",\n \"role\": \"member\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.moonshot.ai/v1/admin/organizations/invites")
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 \"invitee\": \"[email protected]\",\n \"invitee_type\": \"email\",\n \"role\": \"member\"\n}"
response = http.request(request)
puts response.read_body{
"code": "<string>",
"role": "admin",
"status": "pending",
"invitee": "<string>",
"nick_name": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}This endpoint requires an Admin Key with the
org:write scope, and the key owner must still be an organization admin at call time (otherwise 403 owner_not_admin).Nicknames only support Chinese characters, letters, and digits (1-32 characters). When omitted, a nickname is generated automatically: for email invitations, the part before @ is used with unsupported characters stripped; for phone invitations, the default nickname user is used — the phone number is never used.Authorizations
Send the Admin API secret as a Bearer token in the Authorization header (Bearer sk-admin-***). Create Admin Keys under Console → Organization → Admin API Keys.
Body
application/json
Phone number or email address, per invitee_type.
Example:
Contact type: phone or email.
Available options:
phone, email Example:
"email"
Organization role the invitee gets upon joining: admin or member.
Available options:
admin, member Example:
"member"
Invitee display nickname (1-32 characters; Chinese characters, letters, and digits only). Generated automatically when omitted: for email invitations the part before @ is used with unsupported characters stripped; phone invitations get the default nickname and never derive from the phone number.
Response
Created invitation (invitee masked).
Invitation code, returned in plain text for exact lookup / identification.
Organization role the invitee gets upon joining: admin or member.
Available options:
admin, member Invitation status: pending or accepted.
Available options:
pending, accepted Masked invitee contact — emails keep the first letter of the local part (e.g. a***@x.com), phone numbers keep the first 3 and last 4 digits (e.g. 138****1234). Applied consistently in list, detail, and create responses.
Invitee display nickname.
Was this page helpful?
⌘I
Create organization invitation
curl --request POST \
--url https://api.moonshot.ai/v1/admin/organizations/invites \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"invitee": "[email protected]",
"invitee_type": "email",
"role": "member"
}
'import requests
url = "https://api.moonshot.ai/v1/admin/organizations/invites"
payload = {
"invitee": "[email protected]",
"invitee_type": "email",
"role": "member"
}
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({invitee: '[email protected]', invitee_type: 'email', role: 'member'})
};
fetch('https://api.moonshot.ai/v1/admin/organizations/invites', 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.moonshot.ai/v1/admin/organizations/invites",
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([
'invitee' => '[email protected]',
'invitee_type' => 'email',
'role' => 'member'
]),
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.moonshot.ai/v1/admin/organizations/invites"
payload := strings.NewReader("{\n \"invitee\": \"[email protected]\",\n \"invitee_type\": \"email\",\n \"role\": \"member\"\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.moonshot.ai/v1/admin/organizations/invites")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"invitee\": \"[email protected]\",\n \"invitee_type\": \"email\",\n \"role\": \"member\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.moonshot.ai/v1/admin/organizations/invites")
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 \"invitee\": \"[email protected]\",\n \"invitee_type\": \"email\",\n \"role\": \"member\"\n}"
response = http.request(request)
puts response.read_body{
"code": "<string>",
"role": "admin",
"status": "pending",
"invitee": "<string>",
"nick_name": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "invalid_request",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}