Skip to content

Accept Invitation

POST
/api/v1/members/invitations/{token}/accept
curl --request POST \
--url https://api.ultimateteam.ai/api/v1/members/invitations/example/accept \
--header 'X-API-Key: <X-API-Key>'

Accept an invitation and bind it to the authenticated user.

token
required
Token
string

Successful Response

Media typeapplication/json
AcceptResponse

POST /api/v1/members/invitations/{token}/accept response body.

object
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
tenant_id
required
Tenant Id
string format: uuid
Example
{
"role": "chairman",
"status": "invited"
}

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"
}
]
}