Skip to content
TTX-Zone
The API may change between versions while TTX-Zone is 0.x.

Preview email invitation

POST
/api/v1/email-invitations/preview
curl --request POST \
  --url https://example.com/api/v1/email-invitations/preview \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example" }'

What an email invitation’s link grants, before accepting it.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
EmailInvitationTokenRequest
object
token
required
Token
string
>= 1 characters <= 128 characters

Example generated

{
  "token": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
EmailInvitationPreview
object
account_exists
required
Account Exists
boolean
email_hint
required
Email Hint
string
organization_name
required
Organization Name
string
ttx_name
required
Ttx Name
string

Example generated

{
  "account_exists": true,
  "email_hint": "example",
  "organization_name": "example",
  "ttx_name": "example"
}

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

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}