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

Redeem invitation token

POST
/api/v1/invitation-tokens/redeem
curl --request POST \
  --url https://example.com/api/v1/invitation-tokens/redeem \
  --header 'Content-Type: application/json' \
  --data '{ "account": { "accepted_legal": [ { "kind": "terms", "version": 1 } ], "email": "hello@example.com", "full_name": "example", "password": "example" }, "token": "example" }'

Join an exercise with an invitation token, creating the account if asked.

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
accept-language
Any of:
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
InvitationTokenRedeemRequest
object
account
Any of:
RedeemAccountCreate
object
accepted_legal
Accepted Legal
Array<object>
<= 4 items
LegalAcceptanceItem

One version of one document the user accepts (signup, or after a substantial change). Must be the version currently published.

object
kind
required
LegalDocumentKind

The legal documents a deployment’s operator publishes for its users (Platform), accepted together at signup.

string
Allowed values: terms privacy
version
required
Version
integer
>= 1
email
required
Email
string format: email
full_name
required
Full Name
string
>= 1 characters <= 255 characters
password
required
Password
string
>= 8 characters <= 128 characters
token
required
Token
string
>= 1 characters

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
InvitationTokenRedeemResponse
object
organization_domain
required
Any of:
string
organization_name
required
Organization Name
string
role
required
RoleEnum

TTX-scoped roles: PLANNER is a member of the exercise’s planning and control team (what they do on it – plan, control, facilitate – is in the row’s flags); EVALUATOR rates the exercise with the EEG and OBSERVER watches it, neither with access to the design; PLAYER plays it.

string
Allowed values: planner evaluator observer player
status
required
Status
string
Allowed value: pending
ttx_id
required
Ttx Id
string format: uuid
ttx_name
required
Ttx Name
string
user
required
UserRead
object
email
required
Email
string
full_name
required
Full Name
string
id
required
Id
string format: uuid

Example 

{
  "role": "planner",
  "status": "pending"
}

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