Skip to content
UltimateTeam.ai Docs

Invite Member

POST
/api/v1/members/invite
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/members/invite \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "email": "hello@example.com", "role": "operator" }'

Issue an invitation for a new tenant member.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
InviteRequest

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

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

Responses

Section titled “ Responses ”

201

Section titled “201”

Successful Response

Media typeapplication/json
InviteResponse

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

object
accept_url
required
Accept Url

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

string
email
required
Email
string format: email
expires_at
required
Expires At
string format: date-time
membership_id
required
Membership Id
string format: uuid
role
required
Role
string
Allowed values: chairman operator viewer
status
required
Status
string
Allowed values: invited active suspended removed
Example
{
  "role": "chairman",
  "status": "invited"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}