Create a Connect Link

Create a sign-in link for a Google Workspace or Microsoft 365 mailbox you already own, so you can warm it up with InboxKit. Send the link to the person who uses the mailbox. When they sign in and allow access, the mailbox is connected to your workspace.

The link works once and is valid for 72 hours.

Set email so that only that mailbox can use the link.

Set start_warmup to true to start warmup as soon as the mailbox connects. The first month is charged to your wallet at that moment, at the price shown by Get Warmup Pricing. If your wallet balance is too low at that moment, the mailbox still connects but warmup does not start.

Personal Gmail and Outlook.com accounts cannot be connected.

One-time setup by an admin of the mailbox's organization

The response includes a setup object for the platform:

Google Workspace: in the Google Admin console (admin_console_url), add client_id as a trusted app with the listed scopes.

Microsoft 365: open admin_consent_url once and approve access for the organization.

After the link is sent

Check progress with Get Connect Link Status. Once connected, the mailbox appears in List Your Connected Mailboxes. To start warmup later for a mailbox you connected without start_warmup, send its ext_mbx_ UID to Add Warmup to Mailboxes.

connect_url is returned only in this response. Keep it private: anyone with the link can use it until it is used or expires.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location 'https://api.inboxkit.com/v1/api/warmup/external/connect-links' \ --header 'X-Workspace-Id;' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "platform": "GOOGLE", "email": "[email protected]", "start_warmup": true }'

{ "error": false, "message": "Connect link created", "connection": { "connection_id": "ext_con_9e4b2d71-3c8f-4a65-b1d9-7f2a5c8e0d43", "platform": "GOOGLE", "status": "awaiting_consent", "failure_reason": null, "failure_message": null, "email": "[email protected]", "start_warmup": true, "external_mailbox_uid": null, "subscription_uid": null, "created_at": "2026-11-03T09:15:00.000Z", "completed_at": null, "expires_at": "2026-11-06T09:15:00.000Z", "external_mailbox": null, "connect_url": "https://accounts.google.com/o/oauth2/v2/auth?client_id=123456789012-a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6.apps.googleusercontent.com&redirect_uri=https%3A%2F%2Fapi.inboxkit.com%2Fv1%2Fpublic%2Fmailbox-connect%2Fgoogle%2Fcallback&response_type=code&scope=openid+email+https%3A%2F%2Fmail.google.com%2F+https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fgmail.modify+https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fgmail.settings.basic+https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fgmail.settings.sharing&state=Q7mZt2Lx9VbK4nRc8WsY1pDf6HjA3uEo5GiN0kTqBwM&code_challenge=Xk3Rp9Lm2Vq7Tn5Bw8Yc1Hd4Fs6Gj0Ze2Ua9Ni3Ko7Pe&code_challenge_method=S256&access_type=offline&prompt=consent&login_hint=sales%40example.com" }, "setup": { "client_id": "123456789012-a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6.apps.googleusercontent.com", "scopes": [ "openid", "email", "https://mail.google.com/", "https://www.googleapis.com/auth/gmail.modify", "https://www.googleapis.com/auth/gmail.settings.basic", "https://www.googleapis.com/auth/gmail.settings.sharing" ], "admin_console_url": "https://admin.google.com/ac/owl/list?tab=configuredApps" } }

Create a Connect Link

Request

Responses