Skip to main content
POST
/
tenant
/
members
/
invite
Invite Member
curl --request POST \
  --url http://localhost:8000/tenant/members/invite \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "role": "tenant_admin"
}
'
{
  "email": "[email protected]",
  "invited_at": "2024-01-01T00:00:00Z",
  "last_login_at": "2024-06-01T12:00:00Z",
  "member_id": "aa0e8400-e29b-41d4-a716-446655440000",
  "name": "Jane Doe",
  "role": "tenant_admin",
  "status": "active",
  "user_id": "bb0e8400-e29b-41d4-a716-446655440000"
}

Headers

​
authorization
string | null
​
x-api-key
string | null
​
x-tenant-id
string | null

Cookies

​
factio_access_token
string | null

Body

application/json

Schema for inviting a new member to a tenant.

​
email
string
required

Email address of the user to invite

Maximum string length: 255
Pattern: ^[^@\s]+@[^@\s]+\.[^@\s]+$
​
role
enum<string>
required

Role to assign to the invited member (platform_admin not allowed)

Available options:
platform_admin,
tenant_owner,
tenant_admin,
billing_operator,
accountant,
viewer

Response

Successful Response

Schema for a tenant member response.

​
member_id
string<uuid>
required
​
user_id
string<uuid>
required
​
name
string | null
required
​
email
string
required
​
role
string
required
​
status
string
required
​
invited_at
string<date-time> | null
required
​
last_login_at
string<date-time> | null
required