Skip to main content
POST
Reconnect mailbox

Authorizations

Authorization
string
header
required

Path Parameters

workspaceID
string
required

Workspace ID

mailboxID
string
required

Mailbox ID

Body

application/json

Reconnect request. redirectUrl required for Google/Outlook (allowlisted); omit for SMTP/IMAP.

The body is of type object.

Response

Reconnect outcome

mailbox
object
message
string

Short explanation of the outcome.

Example:

"Mailbox credentials were verified and the mailbox is active again."

nextStep
string

What the caller should do next.

Example:

"Nothing to do."

oauthUrl
string

OAuth authorization URL. Present only when result is oauth_required.

Example:

"https://accounts.google.com/o/oauth2/auth?..."

result
enum<string>

Explicit reconnect outcome. Prefer this over combining fields with mailbox.status.

Available options:
reconnected,
already_connected,
disconnected,
oauth_required,
suspended,
deleted,
pending,
ineligible
Example:

"reconnected"