Skip to main content
POST
/
api
/
v1
/
organisations
/
invite
Invite User Endpoint
import requests

url = "https://platform.ankra.app/api/v1/organisations/invite"

payload = {
    "organisation_id": "<string>",
    "invitee_email": "jsmith@example.com",
    "role": "member"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
{
  "success": true,
  "message": "<string>"
}

Headers

authorization
string | null

Body

application/json
organisation_id
string<uuid4>
required
invitee_email
string<email>
required
role
enum<string>
required
Available options:
member,
admin,
read-only

Response

Successful Response

success
boolean
required
message
string
required
I