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

Send email invitations

POST
/api/v1/ttx/{ttx_id}/email-invitations

Invite people to the exercise as Players by email.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
EmailInvitationCreateRequest
object
emails
required
Emails
Array<string>
>= 1 items <= 50 items

Example generated

{
  "emails": [
    "example"
  ]
}

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
EmailInvitationCreateResponse
object
results
required
Results
Array<object>
EmailInvitationOutcome
object
email
required
Email
string
outcome
required
Outcome
string
Allowed values: sent resent already_player on_team dropped

Example 

{
  "results": [
    {
      "outcome": "sent"
    }
  ]
}

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