Send a test email

POST

/api/v1/email/test

curl --request POST \
  --url http://localhost:3000/api/v1/email/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "to": "hello@example.com" }'

Through the organization’s email settings, to your own address only. A 422 carries the provider’s reason, a 429 says the organization’s emails for the day are spent. Organization admin.

Any caller; the scope needed is checked on what it acts on.

Authorizations

• bearer
• session
• None

Request Body^required

Media typeapplication/json

object

to

Your own address, the only one a test goes to

string format: email

/^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

Example^generated

{
  "to": "hello@example.com"
}

Responses

200

Sent

Media typeapplication/json

object

data

required

object

sent

required

boolean

to

required

string

Example

{
  "data": {
    "sent": true
  }
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}