Get Connect Link Status
GET
https://api.inboxkit.com/v1/api/warmup/external/connect-links/{connection_id}
Maintainer:Not configured
status | Meaning |
|---|---|
awaiting_consent | The link has not been used yet. |
connected | The mailbox is connected. If you asked for start_warmup and warmup did not start, failure_reason says why. |
warmup_started | The mailbox is connected and warmup started. subscription_uid is set. |
failed | The sign-in did not complete. failure_reason says why. |
expired | The link was not used within 72 hours. |
failure_reason | What to do |
|---|---|
access_denied | The mailbox owner did not allow access. Send a new link and ask them to allow all requested access. |
permissions_missing | Not all requested access was granted. Send a new link and ask them to allow everything. |
admin_approval_required | An admin of the organization must approve the app first. See setup in Create a Connect Link. |
email_mismatch | The owner signed in with a different account than the email the link was created for. |
personal_account_not_supported | Personal Gmail and Outlook.com accounts cannot be connected. |
sign_in_failed | Google or Microsoft did not complete the sign-in. Send a new link. |
already_connected | This mailbox is already connected. |
insufficient_credits | The mailbox connected, but your wallet balance was too low to start warmup. Add credits, then start warmup with Add Warmup to Mailboxes. |
warmup_start_failed | The mailbox connected, but warmup could not start. Try again later with Add Warmup to Mailboxes. |
expired | Create a new link. |
Request
Path Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.inboxkit.com/v1/api/warmup/external/connect-links/ext_con_9e4b2d71-3c8f-4a65-b1d9-7f2a5c8e0d43' \
--header 'X-Workspace-Id;' \
--header 'Authorization: Bearer <token>'Response Response Example
200 - Not used yet
{
"error": false,
"message": "Connect link retrieved successfully",
"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
}
}Modified at 2026-10-22 10:54:10