Skip to content

Invite Member

POST
/api/v1/members/invite

Issue an invitation for a new tenant member.

Authorizations

Request Body required

POST /api/v1/members/invite request body.

object
email
required
string format: email
role
string
default: viewer
Allowed values: operator viewer

Responses

201

Successful Response

POST /api/v1/members/invite response body.

object
accept_url
required

Frontend route the invitee follows to accept (token embedded in path).

string
email
required
string format: email
expires_at
required
string format: date-time
membership_id
required
string format: uuid
role
required
string
Allowed values: chairman operator viewer
status
required
string
Allowed values: invited active suspended removed

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string