API Reference
Getting Started
Core Concepts
Backend API — Guides
Frontend API — Guides
OAuth & OpenID Connect — Guides
Enterprise: SSO & SCIM — Guides
Webhooks — Guides
SDKs
Backend API (BAPI)
Frontend API (FAPI)
Dashboard API
Public API
SCIM
OIDC
Platform

Messaging Providers

AdminUpdated Sep 11, 2026

Messaging Providers

Dashboard API — authenticated by an Atlas console (platform-instance) session, not a key.

5 routes. Each row is one endpoint with its explanation and whether it honours the Idempotency-Key header.

Method & path

Idem

Explanation

GET /v1/dashboard/accounts/:accountId/instances/:instanceId/messaging_providers

Read the BYOK email and SMS providers with the plan and whether managed sending is available. Secrets are never returned, only which are set.

PUT /v1/dashboard/accounts/:accountId/instances/:instanceId/messaging_providers/email

Store the email provider (resend, ses or smtp). Secrets are write-only; a blank or omitted secret keeps the stored one.

PUT /v1/dashboard/accounts/:accountId/instances/:instanceId/messaging_providers/sms

Store the SMS provider (twilio). The auth_token is write-only; a blank or omitted value keeps the stored one.

DELETE /v1/dashboard/accounts/:accountId/instances/:instanceId/messaging_providers/:channel

Forget a channel's BYOK provider. The instance falls back to managed-if-paid.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/messaging_providers/:channel/test

Send a clearly-marked test message to a destination to verify the configured email or SMS provider delivers, without triggering a real auth flow. Owner or admin; rate-limited; 422 when nothing is configured.

Was this page helpful?