Test send through a Provider

Sends ONE REAL message through a stored provider, to a destination you name, so you can find out whether its credentials work before anyone depends on them.

This is not a dry run: a real e-mail or SMS is delivered and, for SMS, may be billed by the carrier.

The two failure modes are deliberately distinguishable, because they call for opposite actions:

• 422 IDE-1016 — the provider REJECTED the credentials. Fatal: fix the configuration.
• 400 IDE-1017 — the credentials were accepted but the message was not delivered. The configuration may be perfectly fine — a trial account that refuses unverified recipients answers exactly this.

Other failures:

• 404 — no such provider in your organization.
• 503 IDE-0066 — the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.

POST /v1/providers/{id}/test-send

Test send through a Provider

cURL

curl --request POST \
  --url https://identity.sandbox.lerian.net/v1/providers/{id}/test-send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "phone": "<string>"
}
'

200

{
  "category": "SMS",
  "delivered": true,
  "providerId": "00000000-0000-0000-0000-000000000000"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Path Parameters

id · string · required

Provider ID.

Example:

"smtp-primary"

Body

application/json

Where to send the single test message.

email · string

phone · string

Response

200

application/json

OK

category · enum<string>

Available options: Email, SMS

Example:

"SMS"

delivered · boolean

Example:

true

providerId · string

Example:

"00000000-0000-0000-0000-000000000000"