Send a platform plugin test email.

POST

/api/admin/platform/plugins/{id}/test-email

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/platform/plugins/example/test-email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "to": "admin@example.com", "tenant_id": "default", "config": { "from": "no-reply@example.com" } }'

Sends a test email through the selected materialized Plugin Runner installation using saved platform configuration. Invalid plugin type/configuration returns 400; a durable pending delivery returns 202 and a permanent provider failure returns 502.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Request Body ^required

Media type application/json

object

to

required

string format: email

tenant_id

string

key

additional properties

Example

{
  "to": "admin@example.com",
  "tenant_id": "default",
  "config": {
    "from": "no-reply@example.com"
  }
}

Responses

200

Plugin test email response.

Media type application/json

object

success

required

boolean

pluginId

required

string

tenantId

required

string | null

to

required

string format: email

messageId

required

string | null

deliveryState

required

string

Allowed values: delivered pending

key

additional properties

Example

{
  "success": true,
  "deliveryState": "delivered"
}

202

Plugin test email response.

Media type application/json

object

success

required

boolean

pluginId

required

string

tenantId

required

string | null

to

required

string format: email

messageId

required

string | null

deliveryState

required

string

Allowed values: delivered pending

key

additional properties

Example

{
  "success": true,
  "deliveryState": "delivered"
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

502

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}