Skip to main content
POST
Reconnect email account

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Headers

Email-Box-SID
string

Email server (em_bx_...) the call is for, from search_email_boxes. Omitted: the primary server.

Pattern: ^em_bx_[A-Za-z0-9]{12}$

Path Parameters

sid
string
required

Path segment {sid}.

Required string length: 18
Pattern: ^em_ac_

Body

application/json

Request body of reconnect_email_account.

email_oauth_app_sid
string | null

google and microsoft: consent through this application of the team; null: the platform's. Absent: the one the mailbox already uses.

Required string length: 18
Pattern: ^em_oa_
success_redirect_url
string<uri>

Where the hosted page sends the person when done.

Maximum string length: 2048
connection
object

imap_smtp, inline form: the servers, with both passwords.

imap_password
string
Maximum string length: 1024
smtp_password
string
Maximum string length: 1024

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
object | null
required
result
object
required
meta
object
required