Skip to content
Authrim

Send a tenant plugin test email.

POST
/api/admin/plugins/{id}/test-email
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/plugins/example/test-email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "to": "[email protected]", "tenant_id": "default", "config": { "from": "[email protected]" } }'

Send a test email through a configured built-in email notifier plugin and return provider delivery metadata.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Plugin identifier.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
to
required
string format: email
tenant_id
string
config
object
key
additional properties
key
additional properties
Example 
{
  "to": "[email protected]",
  "tenant_id": "default",
  "config": {
    "from": "[email protected]"
  }
}

Responses

Section titled “ Responses ”

200

Section titled “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
providerResponse
required
One of:
object
key
additional properties
key
additional properties
Example 
{
  "success": true
}

400

Section titled “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

Section titled “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

Section titled “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

Section titled “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

Section titled “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

Section titled “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"
}