Send one test message through an application's mail server
Send one test message through an application's mail server: CustomDomain™ API reference. Covers request parameters, the request body, responses and error codes.
Sends a short test message to to through the saved SMTP server (mode must be smtp). On success verified_at is recorded; on failure last_error is recorded (with no secret in it) and the response is 502. Limited to 5 per hour per application. Requires app:write.
Long-lived tenant API key, cd_live_… (production) or cd_test_… (staging, development), stored hashed. Keys created before the switch to cd_ start with sk_live_… / sk_test_… and are still accepted. Scoped to the owning application's tenant.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/applications/string/email-sender:test" \ -H "Content-Type: application/json" \ -d '{ "to": "string" }'{ "ok": true, "verified_at": "2019-08-24T14:15:22Z"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}