On this page

POST/accounts/connect-link · POST /accounts/:id/reconnect-link

Mint a browser URL so the user finishes mailbox auth. The API never handles mailbox credentials. After connect, the account appears in GET /accounts.

0 credits. Rate class: campaign_control (default 20/min).


POST /accounts/connect-link

New sending mailbox. Not idempotent — each call mints a fresh link.

Request

{ "mailboxKind": "gmail" }
FieldRequiredNotes
mailboxKindYesgmail · outlook · imap (case-insensitive). Not kind.
curl -sS -X POST -H "X-API-Key: $KEY" -H "Content-Type: application/json" \
  -d '{"mailboxKind":"gmail"}' \
  "https://api.notiq.io/public/v1/accounts/connect-link"

Response

{
  "connectUrl": "https://…",
  "mailboxKind": "gmail"
}

Have the user open connectUrl in a browser, then call GET /accounts again.

Errors

validation_error · plan_required / conflict (inbox pool / plan limits) · rate_limited · upstream_unavailable

MCP

Tool: create_mailbox_connect_link (body field mailboxKind).


POST /accounts/:id/reconnect-link

Re-authorize an existing mailbox (expired / revoked). Body is ignored.

Response

{
  "accountId": "acc_1",
  "connectUrl": "https://…",
  "mailboxKind": "gmail"
}

Errors

not_found · conflict when the account cannot be reconnected · rate_limited · upstream_unavailable

MCP

Tool: create_mailbox_reconnect_link.