Test email provider configuration

Sends a test email using the provided credentials. Does not save the configuration.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

provider*string

Value in"resend" | "sendgrid" | "postmark" | "smtp" | "ses"

apiKey?string

Provider API key to test. Omit to test the currently saved key.

Length1 <= length

fromAddress*string

Length1 <= length

recipientEmail*string

Formatemail

Response Body

`application/json`

curl -X POST "http://localhost:3001/api/v1/admin/email-provider/test" \  -H "Content-Type: application/json" \  -d '{    "provider": "resend",    "fromAddress": "string",    "recipientEmail": "user@example.com"  }'

{
  "success": true,
  "message": "string"
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

{
  "property1": null,
  "property2": null
}

{
  "property1": null,
  "property2": null
}

{
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

Test email provider configuration

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`