Messaging Providers
- Written for
- ＋ Written for
- Deprecated
- ＋ Deprecated
- Applies to
- ＋ Applies to
Messaging Providers
Backend API — secret key (Authorization: Bearer sk_…).
5 routes. Each row is one endpoint with its explanation, required scope, and whether it honours the Idempotency-Key header.
Method & path | Scope | Idem | Explanation |
|---|---|---|---|
|
| Read the instance's BYOK email and SMS provider config: transport, from-address and which secret keys are set. Never returns a secret value. | |
|
| Configure the email delivery provider (Resend/SES/SMTP/Brevo/Mailgun). The provider secret is write-only; an omitted secret keeps the stored one. | |
|
| Configure the SMS delivery provider (Twilio). The auth token is write-only. | |
|
| Remove the email or sms provider configuration for the instance. | |
|
| Send a clearly-marked test message to a destination to verify the configured email or SMS provider delivers, without triggering a real auth flow. Rate-limited; 422 when nothing is configured. |