Skip to main content
POST
/
api
/
v1
/
org
/
organisation
/
invite
Invite user to organisation
import requests

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

payload = {
    "organisation_id": "<string>",
    "invitee_email": "[email protected]"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
authorization
string | null
​
x-ankra-organisation-id
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

User invited successfully

​
success
boolean
required
​
message
string
required