Connect a mailbox from any provider
Connects one mailbox from any email provider with its server settings. Argorant first signs in to send and to read replies and connects the mailbox only when both work; otherwise the answer is sign_in_failed with the test result. The password is stored encrypted and never returned. Connecting the same address again replaces its settings, which is how a mailbox is reconnected after a password change. A free trial connects up to 2 mailboxes. Up to 30 connects an hour; use the bulk route for more.
| Cost | What it does | Key scopes |
|---|---|---|
| Free | Writes | argorant:manage_lists |
Request
- Base URL: https://app.argorant.com
- URL: https://app.argorant.com/api/v1/inboxes/smtp
- Auth: HTTP bearer
Headers
Any unique text up to 128 characters. A retry with the same key and the same body within 24 hours returns the first answer (with the header Idempotent-Replayed: true) instead of doing the work twice. The same key with another body answers 409 idempotency_conflict.
Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.
Request body
Example request
{
"email": "elena@northgate-advisory.com",
"display_name": "Elena Vaughn",
"preset": "zoho",
"smtp_host": "smtppro.zoho.com",
"smtp_port": 587,
"imap_host": "imappro.zoho.com"
}Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.