Email

Test an email connection

Checks the saved settings from the region that sends, step by step:

  • brevo: credentials, senders (the verified senders and domains) and sandbox_send (Brevo checks an email from the default sender without delivering it).
  • smtp: connect, starttls, smtp_auth.
  • postmark: credentials.
  • resend: credentials, which also lists the verified domains.
  • ses: credentials, senders (the verified identities; it fails when there are none).
  • graph: credentials (Microsoft Entra ID issues a token).

The senders found are stored as the connection's senders. send_to adds a real test email (send) to a verified member address. 200 with ok: false means a step failed; the test stops there. A failed credentials or smtp_auth step marks the connection failing.

post/v1/email-connections/{connection_id}/test

Request

  • Base URL: https://api-eu.dynamicdocumentapi.com
  • URL: https://api-eu.dynamicdocumentapi.com/v1/email-connections/{connection_id}/test
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

connection_idstring required

Email connection id (emc_…).

Headers

Idempotency-Keystring

Replays the stored response for 24 h; a different body with the same key → 422.

Request body

send_tostring nullable

Also send a real test email to this address: the verified address of a workspace member.

Response

The test ran; check ok.

objectstring
okboolean required

Changes

No recorded changes to this operation across all 2 revisions of this API.