Create, Update & Warmup
Connect a new email account, update its settings and manage warmup: all write paths for /api/v1/email-accounts.
These endpoints write to /api/v1/email-accounts, except the two reads at the end, which only need the read scope. None of them ever returns a password, app password or OAuth token. Each has its own page with parameters, errors and a Try it panel.
| Endpoint | Page |
|---|---|
POST /api/v1/email-accounts | Create Email Account |
PATCH /api/v1/email-accounts/{account_id} | Update Email Account |
POST /api/v1/email-accounts/{account_id}/reconnect | Reconnect Email Account |
POST /api/v1/email-accounts/{account_id}/warmup/enable | Enable Warmup |
POST /api/v1/email-accounts/{account_id}/warmup/disable | Disable Warmup |
GET /api/v1/email-accounts/{account_id}/health | Get Account Health |
GET /api/v1/email-accounts/{account_id}/warmup | Get Account Warmup |
POST /api/v1/email-accounts/google-oauth/start | Start Google Sign-in |
POST /api/v1/email-accounts/microsoft-oauth/start | Start Microsoft Sign-in (beta) |
DELETE /api/v1/email-accounts/{account_id} | Delete Email Account |
Was this page helpful?