Reconnect a mailbox | Swarmhit Developers

New credentials or settings for the same mailbox, in place (same id), with the same body as a connect. provider may differ from the mailbox's type (a password mailbox moved to your Google or Microsoft OAuth app, or back): the old login is replaced and the account's type follows. The next OK is sent as RECONNECTED; a refused reconnect changes nothing.

Authorization

X-API-KEY<token>

Your API key from the console (gw_live_…).

In: header

Path Parameters

id*string

A mailbox (em_…).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The three kinds of connection in one body, plus Swarmhit's: oauth_app_id, email, name, expires_at, imap_tls / smtp_tls.

provider*string

Value in

"MAIL"
"GOOGLE_OAUTH"
"OUTLOOK"

imap_host?string

imap_port?integer

imap_user?string

imap_password?string

imap_encryption?string

SSL/TLS (TLS from the start) or STARTTLS; left out, by the port (993: TLS).

imap_tls?boolean

Swarmhit's own: TLS from the start (true) or STARTTLS (false); wins over imap_encryption.

smtp_host?string

smtp_port?integer

smtp_user?string

smtp_password?string

smtp_tls?boolean

Swarmhit's own: TLS from the start (true, port 465) or STARTTLS (false, 587); left out, by the port.

access_token?string

refresh_token?string

expires_at?string

Swarmhit's own: when access_token expires.

Formatdate-time

oauth_app_id?string

Swarmhit's own, required for GOOGLE_OAUTH and OUTLOOK: the OAuth app (emo_…) that issued the tokens. A service app needs no token.

email?string

Swarmhit's own: the mailbox's address (required for GOOGLE_OAUTH; for MAIL when imap_user is not an address).

username?string

Outlook: the mailbox's address.

id?string

Outlook: the provider's user id (accepted, not needed).

mailbox_id?string

Outlook: a shared or delegated mailbox to use.

name?string

Swarmhit's own: the display name.

proxy?

Response Body

`application/json`

curl -X POST "https://example.com/email/api/v1/accounts/em_gX2kP9qL4mT7vB1nR8sW3yZ" \  -H "Content-Type: application/json" \  -d '{    "provider": "MAIL"  }'

{  "object": "AccountReconnected",  "account_id": "string"}

Authorization

Path Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

404application/json

429application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`