Account

Request reconnect

Requests connection to be reconnected<br/><br/>The request only schedules the work and returns before it finishes. Watch the account state, or the accountInitialized and authenticationError webhooks, for the result.

put/v1/account/{account}/reconnect

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/account/{account}/reconnect
  • Auth: HTTP bearer

Path parameters

accountstring required

Unique identifier for the email account

Example:user123

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Request body

reconnectboolean

Only reconnect if true

Response

Returns an acknowledgement. The reconnect is requested, not completed - watch the account state for the result.

reconnectboolean

Reconnection status

Changes

No recorded changes to this operation across all 1 revision of this API.