Email

Retrieve an email connection

Common base: API key or OAuth only, never a dashboard region token.

get/v1/email-connections/{connection_id}

Request

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

Path parameters

connection_idstring required

Email connection id (emc_…).

Response

configobject required

The provider's settings (see the write config), always with attachment_budget_bytes and max_per_second: the provider's defaults unless set.

created_atstring date-time required
credentials_delete_atstring date-time nullable required

Set after a downgrade: the credentials are deleted then.

egress_ipsstring[] required

The addresses our email traffic leaves from: authorize them at providers that restrict calling IPs (Brevo: Security → Authorized IPs).

eventsobject required

Brevo connections only: the delivery-events webhook in the Brevo account, per region; empty for other providers.

idstring required

emc_…

last_test_atstring date-time nullable required
last_test_status'succeeded' | 'failed' | 'null' nullable required
  • succeeded - succeeded
  • failed - failed
namestring required
objectstring
provider'brevo' | 'smtp' | 'postmark' | 'resend' | 'ses' | 'graph' required
  • brevo - Brevo
  • smtp - SMTP
  • postmark - Postmark
  • resend - Resend
  • ses - Amazon SES
  • graph - Microsoft 365 (Graph)
reply_tostring nullable required
status'active' | 'failing' required
  • active - active
  • failing - failing
test_mode'sandbox' | 'redirect' | 'skip' required
  • sandbox - Sandbox
  • redirect - Redirect
  • skip - Skip
test_recipientstring nullable required
updated_atstring date-time required

Changes

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