Skip to main content
POST
/
api
/
v2
/
external
/
orgs
/
{slug}
/
members
Add Org Member
curl --request POST \
  --url https://api.example.com/api/v2/external/orgs/{slug}/members \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "role": "member"
}
'
import requests

url = "https://api.example.com/api/v2/external/orgs/{slug}/members"

payload = {
"email": "jsmith@example.com",
"role": "member"
}
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({email: 'jsmith@example.com', role: 'member'})
};

fetch('https://api.example.com/api/v2/external/orgs/{slug}/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.example.com/api/v2/external/orgs/{slug}/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' => 'jsmith@example.com',
'role' => 'member'
]),
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.example.com/api/v2/external/orgs/{slug}/members"

payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\n \"role\": \"member\"\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.example.com/api/v2/external/orgs/{slug}/members")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\n \"role\": \"member\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v2/external/orgs/{slug}/members")

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 \"email\": \"jsmith@example.com\",\n \"role\": \"member\"\n}"

response = http.request(request)
puts response.read_body
{
  "member": {
    "user_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "email": "<string>"
  },
  "invite": {
    "id": "<string>",
    "org_id": "<string>",
    "org_slug": "<string>",
    "org_name": "<string>",
    "email": "<string>",
    "invited_by": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Path Parameters

slug
string
required

Body

application/json
email
string<email>
required
role
enum<string>
default:member
Available options:
owner,
admin,
member

Response

Successful Response

Result of POST /orgs/{slug}/members.

The invitee either had a Lyceum account already (status='added', member populated) or didn't (status='invited', invite populated and an invite email was sent).

status
enum<string>
required
Available options:
added,
invited
member
OrgMemberResponse · object | null
invite
OrgInviteResponse · object | null

A pending invite to an org for an email that has no Lyceum user yet.