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"
}
'
{
  "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"
  }
}

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
invite
OrgInviteResponse · object

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