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

Accept email invitation

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

Accept an email invitation, creating the account when there is none.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
EmailInvitationAcceptRequest
object
account
Any of:
EmailInvitationAccountCreate

A new account for the invited address (the address comes from the invitation, never from the form).

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
full_name
required
Full Name
string
>= 1 characters <= 255 characters
password
required
Password
string
>= 8 characters <= 128 characters
token
required
Token
string
>= 1 characters <= 128 characters

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
EmailInvitationAcceptResponse
object
created_account
required
Created Account
boolean
organization_id
required
Organization Id
string format: uuid
organization_name
required
Organization Name
string
ttx_id
required
Ttx Id
string format: uuid
ttx_name
required
Ttx Name
string

Example generated

{
  "created_account": true,
  "organization_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "organization_name": "example",
  "ttx_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "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"
    }
  ]
}