NotiQNotiQ API
API key
On this page

Changelog

2026-10-28 — MCP — wait for Maps discovery (48 tools)

  • MCP tools: 47 → 48 — MCP-only wait_for_campaign_leads polls campaign readiness after create_campaign (resume on time_budget; keeps polling while extensionStatus is FINDING_LEADS).
  • Campaign DTO — GET /campaigns / GET /campaigns/:id include extensionStatus ("FINDING_LEADS" | null) so clients can see UI “Add more leads” / file-import extend in progress.
  • Agent setup runbook: Maps wait + preview_lead before confirm → start_campaign.

2026-10-23 — Templates, tags, goals, exclude desk, mailbox ops (MCP 20 → 47)

  • MCP tools: 20 → 47 (same operations as Public REST; no LinkedIn tools).
  • Setup: GET /setup / get_setup_status.
  • Agents: list/get/create/update/delete templates; assign to campaigns. Public create/update = manual agents; updates are echo-all.
  • Tags: GET/POST /tags, PATCH /tags/:labelKey. Goal write value: Meeting booked.
  • Overview goal: POST /campaigns/:id/overview-goal / set_campaign_goal.
  • Exclude desk: /excluded-leads and /excluded-domains (+ /remove).
  • Ops: manual campaign create, rename/delete campaign, delete lead, pause/resume agent, preview email, account daily limit (Gmail), disconnect account.
  • Mailbox: POST /accounts/connect-link and …/reconnect-link with mailboxKind (gmail | outlook | imap).
  • New writes share rate class campaign_control (default 20/min).
  • CRM slots: lead create / patch / batch-update accept profile + merge fields including custom1…custom10 (detail on GET lead; list omits them).
  • Runbook: /agent-setup.

2026-09-26 — Email validation and website enrichment

  • Added POST /tools/validate-email and MCP validate_email. mode=mx is free. mode=full charges 1 credit only when the ZeroBounce API returns a usable status (cache hits, errors, and short-circuits are free). Insufficient credits → 403 insufficient_credits.
  • Added POST /tools/validate-emails and MCP validate_emails (max 100). Same credit rules; mid-batch credit exhaustion is HTTP 200 with per-item insufficient_credits.
  • Added POST /tools/enrich-website and MCP enrich_website (0 credits). Private, loopback, link-local, and similar hosts return status: unreachable.
  • Rate classes: validate_email (60/min), validate_emails_batch (10/min), enrich_website (20/min).
  • Optional Idempotency-Key on both validate routes.
  • GET /activity events include excludedSource (set on lead_excluded, otherwise null).
  • POST /inbox/messages may return 429 rate_limited for daily send quota or a high-bounce pause (Retry-After), not only inbox RPM.

2026-09-09 — Batch update/delete and excluded list filter

  • Added POST …/leads/batch-update and MCP update_leads_batch (0 credits, max 100, 6/min).
  • Added POST …/leads/batch-delete and MCP delete_leads_batch (0 credits, no refund, irreversible, 10/min; reconciliationFailed).
  • GET …/leads?excluded=true (sort createdAt only; at most one list filter among tag / replied / needsReply / excluded).
  • Rate classes: update_leads_batch (6/min), delete_leads_batch (10/min).
  • Idempotency-Key supported on batch-update / batch-delete (persist when summary.updated > 0 / summary.deleted > 0).

2026-09-08 — Activity, insights overview, and batch leads

  • Added GET /activity (workspace activity feed) and MCP get_recent_activity.
  • Added GET /insights/overview (sampled campaign rankings) and MCP get_insights_overview.
  • Added POST /campaigns/:campaignId/leads/batch (up to 100 emails) and MCP add_leads_batch.
  • Lead list/detail: sort plus repliedAt, lastInboundMessageAt, taggedAt.
  • Campaign stats: emailsOpened, openRate.
  • Rate class add_leads_batch (default 10/min); batch charges 1 credit per created item.

Initial public API

Initial NotiQ Public API + MCP documentation.

Covers REST at https://api.notiq.io/public/v1, MCP at https://mcp.notiq.io, and outbound webhooks (reply.received, lead.tagged, account.disconnected).

How we version this page

API behavior changes will be listed here with a short summary. Markdown docs remain the source of truth for humans and agents; OpenAPI is published at openapi.yaml.