POST
Test Connection

Authorizations

Authorization
string
header
required

Interactive user session: the login JWT, sent as Authorization: Bearer <token>.

Body

application/json

Test credentials that may not be saved yet.

account_id is optional and only used to resolve masked values: editing an account leaves masks in the form, and testing one would otherwise authenticate with a row of asterisks and always fail.

direction
enum<string>
required
Available options:
outbound,
inbound
provider
enum<string>
required
Available options:
ses,
google_smtp,
microsoft_smtp
email
string<email>
required
credentials
Credentials ┬╖ object
account_id
integer | null

Response

Successful Response

ok
boolean
required
message
string
required