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

Send test email

POST
/api/v1/instance/email/test
curl --request POST \
  --url https://example.com/api/v1/instance/email/test \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: <X-CSRF-Token>' \
  --cookie ttx_access_token=<ttx_access_token> \
  --data '{ "to": "example" }'

Sends a test message now (in the administrator’s language) and says how the server answered. Recorded; a few per minute at most.

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
EmailTestRequest
object
to
Any of:
string
<= 320 characters

Example generated

{
  "to": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
EmailTestRead
object
error
required
Any of:
string
ok
required
Ok
boolean
to
required
To
string

Example generated

{
  "error": "example",
  "ok": true,
  "to": "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"
    }
  ]
}