Skip to main content
POST
Request email account connect link

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}$

Body

application/json

Request body of request_email_account_connect_link.

provider
enum<string> | null

Absent: the page shows a provider picker.

Available options:
google,
microsoft,
imap_smtp
email_oauth_app_sid
string | null

Sign in through this application of the team (search_email_oauth_apps); needs provider. Absent: the server's default, else the platform's.

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

Where the page sends the person when done; the host must be allowed.

Maximum string length: 2048
backfill_days
integer | null

Days of history to mirror. Default 90.

Required range: 0 <= x <= 3650
display_name
string | null
Maximum string length: 255
label
string | null

The customer's own tag; carried by the IMAP form.

Maximum string length: 64

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
any
required
result
object
required
meta
object
required